include/opencascade/Expr_GeneralFunction.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_GeneralFunction_HeaderFile
0018 #define _Expr_GeneralFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <Expr_Array1OfNamedUnknown.hxx>
0027 #include <TColStd_Array1OfReal.hxx>
0028 class Expr_NamedUnknown;
0029 class TCollection_AsciiString;
0030
0031
0032 class Expr_GeneralFunction;
0033 DEFINE_STANDARD_HANDLE(Expr_GeneralFunction, Standard_Transient)
0034
0035 //! Defines the general purposes of any function.
0036 class Expr_GeneralFunction : public Standard_Transient
0037 {
0038
0039 public:
0040
0041
0042   //! Returns the number of variables of <me>.
0043   Standard_EXPORT virtual Standard_Integer NbOfVariables() const = 0;
0044
0045   //! Returns the variable denoted by <index> in <me>.
0046   //! Raises OutOfRange if index > NbOfVariables.
0047   Standard_EXPORT virtual Handle(Expr_NamedUnknown) Variable (const Standard_Integer index) const = 0;
0048
0049   //! Returns a copy of <me> with the same form.
0050   Standard_EXPORT virtual Handle(Expr_GeneralFunction) Copy() const = 0;
0051
0052   //! Returns Derivative of <me> for variable <var>.
0053   Standard_EXPORT virtual Handle(Expr_GeneralFunction) Derivative (const Handle(Expr_NamedUnknown)& var) const = 0;
0054
0055   //! Returns Derivative of <me> for variable <var> with
0056   //! degree <deg>.
0057   Standard_EXPORT virtual Handle(Expr_GeneralFunction) Derivative (const Handle(Expr_NamedUnknown)& var, const Standard_Integer deg) const = 0;
0058
0059   //! Computes the value of <me> with the given variables.
0060   //! Raises NotEvaluable if <vars> does not match all variables
0061   //! of <me>.
0062   Standard_EXPORT virtual Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const = 0;
0063
0064   //! Tests if <me> and <func> are similar functions (same
0065   //! name and same used expression).
0066   Standard_EXPORT virtual Standard_Boolean IsIdentical (const Handle(Expr_GeneralFunction)& func) const = 0;
0067
0068   //! Tests if <me> is linear on variable on range <index>
0069   Standard_EXPORT virtual Standard_Boolean IsLinearOnVariable (const Standard_Integer index) const = 0;
0070
0071   Standard_EXPORT virtual TCollection_AsciiString GetStringName() const = 0;
0072
0073
0074
0075
0076   DEFINE_STANDARD_RTTIEXT(Expr_GeneralFunction,Standard_Transient)
0077
0078 protected:
0079
0080
0081
0082
0083 private:
0084
0085
0086
0087
0088 };
0089
0090
0091
0092
0093
0094
0095
0096 #endif // _Expr_GeneralFunction_HeaderFile