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