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
0033 class Expr_FunctionDerivative;
0034 DEFINE_STANDARD_HANDLE(Expr_FunctionDerivative, Expr_GeneralFunction)
0035
0036
0037 class Expr_FunctionDerivative : public Expr_GeneralFunction
0038 {
0039
0040 public:
0041
0042
0043   //! Creates a FunctionDerivative of degree <deg> relative
0044   //! to the <withX> variable.
0045   //! Raises OutOfRange if <deg> lower or equal to zero.
0046   Standard_EXPORT Expr_FunctionDerivative(const Handle(Expr_GeneralFunction)& func, const Handle(Expr_NamedUnknown)& withX, const Standard_Integer deg);
0047
0048   //! Returns the number of variables of <me>.
0049   Standard_EXPORT Standard_Integer NbOfVariables() const Standard_OVERRIDE;
0050
0051   //! Returns the variable denoted by <index> in <me>.
0052   //! Raises OutOfRange if <index> greater than
0053   //! NbOfVariables of <me>.
0054   Standard_EXPORT Handle(Expr_NamedUnknown) Variable (const Standard_Integer index) const Standard_OVERRIDE;
0055
0056   //! Computes the value of <me> with the given variables.
0057   //! Raises DimensionMismatch if Length(vars) is different from
0058   //! Length(values).
0059   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& values) const Standard_OVERRIDE;
0060
0061   //! Returns a copy of <me> with the same form.
0062   Standard_EXPORT Handle(Expr_GeneralFunction) Copy() const Standard_OVERRIDE;
0063
0064   //! Returns Derivative of <me> for variable <var>.
0065   Standard_EXPORT Handle(Expr_GeneralFunction) Derivative (const Handle(Expr_NamedUnknown)& var) const Standard_OVERRIDE;
0066
0067   //! Returns Derivative of <me> for variable <var> with
0068   //! degree <deg>.
0069   Standard_EXPORT Handle(Expr_GeneralFunction) Derivative (const Handle(Expr_NamedUnknown)& var, const Standard_Integer deg) const Standard_OVERRIDE;
0070
0071   //! Tests if <me> and <func> are similar functions (same
0072   //! name and same used expression).
0073   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralFunction)& func) const Standard_OVERRIDE;
0074
0075   //! Tests if <me> is linear on variable on range <index>
0076   Standard_EXPORT Standard_Boolean IsLinearOnVariable (const Standard_Integer index) const Standard_OVERRIDE;
0077
0078   //! Returns the function of which <me> is the derivative.
0079   Standard_EXPORT Handle(Expr_GeneralFunction) Function() const;
0080
0081   //! Returns the degree of derivation of <me>.
0082   Standard_EXPORT Standard_Integer Degree() const;
0083
0084   //! Returns the derivation variable of <me>.
0085   Standard_EXPORT Handle(Expr_NamedUnknown) DerivVariable() const;
0086
0087   Standard_EXPORT TCollection_AsciiString GetStringName() const Standard_OVERRIDE;
0088
0089   Standard_EXPORT Handle(Expr_GeneralExpression) Expression() const;
0090
0091   Standard_EXPORT void UpdateExpression();
0092
0093
0094 friend class Expr_NamedFunction;
0095
0096
0097   DEFINE_STANDARD_RTTIEXT(Expr_FunctionDerivative,Expr_GeneralFunction)
0098
0099 protected:
0100
0101
0102
0103
0104 private:
0105
0106
0107   Handle(Expr_GeneralFunction) myFunction;
0108   Handle(Expr_GeneralExpression) myExp;
0109   Handle(Expr_NamedUnknown) myDerivate;
0110   Standard_Integer myDegree;
0111
0112
0113 };
0114
0115
0116
0117
0118
0119
0120
0121 #endif // _Expr_FunctionDerivative_HeaderFile