include/opencascade/Expr_NamedFunction.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_NamedFunction_HeaderFile
0018 #define _Expr_NamedFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TCollection_AsciiString.hxx>
0024 #include <Expr_Array1OfNamedUnknown.hxx>
0025 #include <Expr_GeneralFunction.hxx>
0026 #include <Standard_Integer.hxx>
0027 #include <TColStd_Array1OfReal.hxx>
0028 class Expr_GeneralExpression;
0029 class Expr_NamedUnknown;
0030
0031
0032 class Expr_NamedFunction;
0033 DEFINE_STANDARD_HANDLE(Expr_NamedFunction, Expr_GeneralFunction)
0034
0035
0036 class Expr_NamedFunction : public Expr_GeneralFunction
0037 {
0038
0039 public:
0040
0041
0042   //! Creates a function of given variables <vars> with name
0043   //! <name> defined by the expression <exp>.
0044   Standard_EXPORT Expr_NamedFunction(const TCollection_AsciiString& name, const Handle(Expr_GeneralExpression)& exp, const Expr_Array1OfNamedUnknown& vars);
0045
0046   //! Sets the name <newname> to <me>.
0047   Standard_EXPORT void SetName (const TCollection_AsciiString& newname);
0048
0049   //! Returns the name assigned to <me>
0050   Standard_EXPORT TCollection_AsciiString GetName() const;
0051
0052   //! Returns the number of variables of <me>.
0053   Standard_EXPORT Standard_Integer NbOfVariables() const Standard_OVERRIDE;
0054
0055   //! Returns the variable denoted by <index> in <me>.
0056   //! Raises OutOfRange if <index> is greater than
0057   //! NbOfVariables of <me>, or less than or equal to zero.
0058   Standard_EXPORT Handle(Expr_NamedUnknown) Variable (const Standard_Integer index) const Standard_OVERRIDE;
0059
0060   //! Computes the value of <me> with the given variables.
0061   //! Raises DimensionMismatch if Length(vars) is different from
0062   //! Length(values).
0063   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& values) const Standard_OVERRIDE;
0064
0065   //! Returns a copy of <me> with the same form.
0066   Standard_EXPORT Handle(Expr_GeneralFunction) Copy() const Standard_OVERRIDE;
0067
0068   //! Returns Derivative of <me> for variable <var>.
0069   Standard_EXPORT Handle(Expr_GeneralFunction) Derivative (const Handle(Expr_NamedUnknown)& var) const Standard_OVERRIDE;
0070
0071   //! Returns Derivative of <me> for variable <var> with
0072   //! degree <deg>.
0073   Standard_EXPORT Handle(Expr_GeneralFunction) Derivative (const Handle(Expr_NamedUnknown)& var, const Standard_Integer deg) const Standard_OVERRIDE;
0074
0075   //! Tests if <me> and <func> are similar functions (same
0076   //! name and same used expression).
0077   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralFunction)& func) const Standard_OVERRIDE;
0078
0079   //! Tests if <me> is linear on variable on range <index>
0080   Standard_EXPORT Standard_Boolean IsLinearOnVariable (const Standard_Integer index) const Standard_OVERRIDE;
0081
0082   Standard_EXPORT TCollection_AsciiString GetStringName() const Standard_OVERRIDE;
0083
0084   //! Returns equivalent expression of <me>.
0085   Standard_EXPORT Handle(Expr_GeneralExpression) Expression() const;
0086
0087   //! Modifies expression of <me>.
0088   //! Warning: Beware of derivatives. See FunctionDerivative
0089   Standard_EXPORT void SetExpression (const Handle(Expr_GeneralExpression)& exp);
0090
0091
0092
0093
0094   DEFINE_STANDARD_RTTIEXT(Expr_NamedFunction,Expr_GeneralFunction)
0095
0096 protected:
0097
0098
0099
0100
0101 private:
0102
0103
0104   TCollection_AsciiString myName;
0105   Handle(Expr_GeneralExpression) myExp;
0106   Expr_Array1OfNamedUnknown myVariables;
0107
0108
0109 };
0110
0111
0112
0113
0114
0115
0116
0117 #endif // _Expr_NamedFunction_HeaderFile