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