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