include/opencascade/Expr_FunctionDerivative.hxx

0001 // Created on: 1991-01-14
0002 // Created by: Arnaud BOUZY
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Expr_FunctionDerivative_HeaderFile
0018 #define _Expr_FunctionDerivative_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <Expr_GeneralFunction.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <Expr_Array1OfNamedUnknown.hxx>
0027 #include <TColStd_Array1OfReal.hxx>
0028 class Expr_GeneralExpression;
0029 class Expr_NamedUnknown;
0030 class TCollection_AsciiString;
0031
0032 class Expr_FunctionDerivative;
0033 DEFINE_STANDARD_HANDLE(Expr_FunctionDerivative, Expr_GeneralFunction)
0034
0035 class Expr_FunctionDerivative : public Expr_GeneralFunction
0036 {
0037
0038 public:
0039   //! Creates a FunctionDerivative of degree <deg> relative
0040   //! to the <withX> variable.
0041   //! Raises OutOfRange if <deg> lower or equal to zero.
0042   Standard_EXPORT Expr_FunctionDerivative(const Handle(Expr_GeneralFunction)& func,
0043                                           const Handle(Expr_NamedUnknown)&    withX,
0044                                           const Standard_Integer              deg);
0045
0046   //! Returns the number of variables of <me>.
0047   Standard_EXPORT Standard_Integer NbOfVariables() const Standard_OVERRIDE;
0048
0049   //! Returns the variable denoted by <index> in <me>.
0050   //! Raises OutOfRange if <index> greater than
0051   //! NbOfVariables of <me>.
0052   Standard_EXPORT Handle(Expr_NamedUnknown) Variable(const Standard_Integer index) const
0053     Standard_OVERRIDE;
0054
0055   //! Computes the value of <me> with the given variables.
0056   //! Raises DimensionMismatch if Length(vars) is different from
0057   //! Length(values).
0058   Standard_EXPORT Standard_Real
0059     Evaluate(const Expr_Array1OfNamedUnknown& vars,
0060              const TColStd_Array1OfReal&      values) const Standard_OVERRIDE;
0061
0062   //! Returns a copy of <me> with the same form.
0063   Standard_EXPORT Handle(Expr_GeneralFunction) Copy() const Standard_OVERRIDE;
0064
0065   //! Returns Derivative of <me> for variable <var>.
0066   Standard_EXPORT Handle(Expr_GeneralFunction) Derivative(
0067     const Handle(Expr_NamedUnknown)& var) const Standard_OVERRIDE;
0068
0069   //! Returns Derivative of <me> for variable <var> with
0070   //! degree <deg>.
0071   Standard_EXPORT Handle(Expr_GeneralFunction) Derivative(const Handle(Expr_NamedUnknown)& var,
0072                                                           const Standard_Integer deg) const
0073     Standard_OVERRIDE;
0074
0075   //! Tests if <me> and <func> are similar functions (same
0076   //! name and same used expression).
0077   Standard_EXPORT Standard_Boolean
0078     IsIdentical(const Handle(Expr_GeneralFunction)& func) const Standard_OVERRIDE;
0079
0080   //! Tests if <me> is linear on variable on range <index>
0081   Standard_EXPORT Standard_Boolean
0082     IsLinearOnVariable(const Standard_Integer index) const Standard_OVERRIDE;
0083
0084   //! Returns the function of which <me> is the derivative.
0085   Standard_EXPORT Handle(Expr_GeneralFunction) Function() const;
0086
0087   //! Returns the degree of derivation of <me>.
0088   Standard_EXPORT Standard_Integer Degree() const;
0089
0090   //! Returns the derivation variable of <me>.
0091   Standard_EXPORT Handle(Expr_NamedUnknown) DerivVariable() const;
0092
0093   Standard_EXPORT TCollection_AsciiString GetStringName() const Standard_OVERRIDE;
0094
0095   Standard_EXPORT Handle(Expr_GeneralExpression) Expression() const;
0096
0097   Standard_EXPORT void UpdateExpression();
0098
0099   friend class Expr_NamedFunction;
0100
0101   DEFINE_STANDARD_RTTIEXT(Expr_FunctionDerivative, Expr_GeneralFunction)
0102
0103 protected:
0104 private:
0105   Handle(Expr_GeneralFunction)   myFunction;
0106   Handle(Expr_GeneralExpression) myExp;
0107   Handle(Expr_NamedUnknown)      myDerivate;
0108   Standard_Integer               myDegree;
0109 };
0110
0111 #endif // _Expr_FunctionDerivative_HeaderFile