include/opencascade/Expr_UnaryMinus.hxx

0001 // Created on: 1991-01-15
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_UnaryMinus_HeaderFile
0018 #define _Expr_UnaryMinus_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Expr_UnaryExpression.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <NCollection_Array1.hxx>
0026 class Expr_GeneralExpression;
0027 class Expr_NamedUnknown;
0028 class TCollection_AsciiString;
0029
0030 class Expr_UnaryMinus : public Expr_UnaryExpression
0031 {
0032
0033 public:
0034   //! Create the unary minus of <exp>.
0035   Standard_EXPORT Expr_UnaryMinus(const occ::handle<Expr_GeneralExpression>& exp);
0036
0037   //! Returns a GeneralExpression after a simplification
0038   //! of the arguments of <me>.
0039   Standard_EXPORT occ::handle<Expr_GeneralExpression> ShallowSimplified() const override;
0040
0041   //! Returns a copy of <me> having the same unknowns and functions.
0042   Standard_EXPORT occ::handle<Expr_GeneralExpression> Copy() const override;
0043
0044   //! Tests if <me> and <Other> define the same expression.
0045   //! This method does not include any simplification before
0046   //! testing.
0047   Standard_EXPORT bool IsIdentical(const occ::handle<Expr_GeneralExpression>& Other) const override;
0048
0049   Standard_EXPORT bool IsLinear() const override;
0050
0051   //! Returns the derivative on <X> unknown of <me>
0052   Standard_EXPORT occ::handle<Expr_GeneralExpression> Derivative(
0053     const occ::handle<Expr_NamedUnknown>& X) const override;
0054
0055   //! Returns the <N>-th derivative on <X> unknown of <me>.
0056   //! Raises OutOfRange if <N> <= 0
0057   Standard_EXPORT occ::handle<Expr_GeneralExpression> NDerivative(
0058     const occ::handle<Expr_NamedUnknown>& X,
0059     const int                             N) const override;
0060
0061   //! Returns the value of <me> (as a Real) by
0062   //! replacement of <vars> by <vals>.
0063   //! Raises NotEvaluable if <me> contains NamedUnknown not
0064   //! in <vars> or NumericError if result cannot be computed.
0065   Standard_EXPORT double Evaluate(const NCollection_Array1<occ::handle<Expr_NamedUnknown>>& vars,
0066                                   const NCollection_Array1<double>& vals) const override;
0067
0068   //! returns a string representing <me> in a readable way.
0069   Standard_EXPORT TCollection_AsciiString String() const override;
0070
0071   DEFINE_STANDARD_RTTIEXT(Expr_UnaryMinus, Expr_UnaryExpression)
0072 };
0073
0074 #endif // _Expr_UnaryMinus_HeaderFile