include/opencascade/Expr_BinaryFunction.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_BinaryFunction_HeaderFile
0018 #define _Expr_BinaryFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_BinaryExpression.hxx>
0024 #include <Expr_Array1OfNamedUnknown.hxx>
0025 #include <TColStd_Array1OfReal.hxx>
0026 class Expr_GeneralFunction;
0027 class Expr_GeneralExpression;
0028 class Expr_NamedUnknown;
0029 class TCollection_AsciiString;
0030
0031 class Expr_BinaryFunction;
0032 DEFINE_STANDARD_HANDLE(Expr_BinaryFunction, Expr_BinaryExpression)
0033
0034 //! Defines the use of a binary function in an expression
0035 //! with given arguments.
0036 class Expr_BinaryFunction : public Expr_BinaryExpression
0037 {
0038
0039 public:
0040   //! Creates <me> as <func> (<exp1>,<exp2>).
0041   //! Raises exception if <func> is not binary.
0042   Standard_EXPORT Expr_BinaryFunction(const Handle(Expr_GeneralFunction)&   func,
0043                                       const Handle(Expr_GeneralExpression)& exp1,
0044                                       const Handle(Expr_GeneralExpression)& exp2);
0045
0046   //! Returns the function defining <me>.
0047   Standard_EXPORT Handle(Expr_GeneralFunction) Function() const;
0048
0049   //! Returns a GeneralExpression after a simplification
0050   //! of the arguments of <me>.
0051   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
0052
0053   //! Returns a copy of <me> having the same unknowns and functions.
0054   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
0055
0056   //! Tests if <me> and <Other> define the same expression.
0057   //! This method does not include any simplification before
0058   //! testing.
0059   Standard_EXPORT Standard_Boolean
0060     IsIdentical(const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
0061
0062   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
0063
0064   //! Returns the derivative on <X> unknown of <me>
0065   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative(
0066     const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
0067
0068   //! Returns the value of <me> (as a Real) by
0069   //! replacement of <vars> by <vals>.
0070   //! Raises NotEvaluable if <me> contains NamedUnknown not
0071   //! in <vars> or NumericError if result cannot be computed.
0072   Standard_EXPORT Standard_Real Evaluate(const Expr_Array1OfNamedUnknown& vars,
0073                                          const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
0074
0075   //! returns a string representing <me> in a readable way.
0076   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
0077
0078   DEFINE_STANDARD_RTTIEXT(Expr_BinaryFunction, Expr_BinaryExpression)
0079
0080 protected:
0081 private:
0082   Handle(Expr_GeneralFunction) myFunction;
0083 };
0084
0085 #endif // _Expr_BinaryFunction_HeaderFile