src/Expr/Expr_Tanh.hxx

   1 // Created on: 1991-01-14
   2 // Created by: Arnaud BOUZY
   3 // Copyright (c) 1991-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Expr_Tanh_HeaderFile
  18 #define _Expr_Tanh_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Expr_UnaryExpression.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Real.hxx>
  26 #include <Expr_Array1OfNamedUnknown.hxx>
  27 #include <TColStd_Array1OfReal.hxx>
  28 class Standard_NumericError;
  29 class Expr_NotEvaluable;
  30 class Expr_GeneralExpression;
  31 class Expr_NamedUnknown;
  32 class TCollection_AsciiString;
  33
  34
  35 class Expr_Tanh;
  36 DEFINE_STANDARD_HANDLE(Expr_Tanh, Expr_UnaryExpression)
  37
  38
  39 class Expr_Tanh : public Expr_UnaryExpression
  40 {
  41
  42 public:
  43
  44
  45   //! Creates the hyperbolic tangent of <exp>.
  46   Standard_EXPORT Expr_Tanh(const Handle(Expr_GeneralExpression)& exp);
  47
  48   //! Returns a GeneralExpression after a simplification
  49   //! of the arguments of <me>.
  50   Standard_EXPORT Handle(Expr_GeneralExpression) ShallowSimplified() const Standard_OVERRIDE;
  51
  52   //! Returns a copy of <me> having the same unknowns and functions.
  53   Standard_EXPORT Handle(Expr_GeneralExpression) Copy() const Standard_OVERRIDE;
  54
  55   //! Tests if <me> and <Other> define the same expression.
  56   //! This method does not include any simplification before
  57   //! testing.
  58   Standard_EXPORT Standard_Boolean IsIdentical (const Handle(Expr_GeneralExpression)& Other) const Standard_OVERRIDE;
  59
  60   Standard_EXPORT Standard_Boolean IsLinear() const Standard_OVERRIDE;
  61
  62   //! Returns the derivative on <X> unknown of <me>
  63   Standard_EXPORT Handle(Expr_GeneralExpression) Derivative (const Handle(Expr_NamedUnknown)& X) const Standard_OVERRIDE;
  64
  65   //! Returns the value of <me> (as a Real) by
  66   //! replacement of <vars> by <vals>.
  67   //! Raises NotEvaluable if <me> contains NamedUnknown not
  68   //! in <vars> or NumericError if result cannot be computed.
  69   Standard_EXPORT Standard_Real Evaluate (const Expr_Array1OfNamedUnknown& vars, const TColStd_Array1OfReal& vals) const Standard_OVERRIDE;
  70
  71   //! returns a string representing <me> in a readable way.
  72   Standard_EXPORT TCollection_AsciiString String() const Standard_OVERRIDE;
  73
  74
  75
  76
  77   DEFINE_STANDARD_RTTIEXT(Expr_Tanh,Expr_UnaryExpression)
  78
  79 protected:
  80
  81
  82
  83
  84 private:
  85
  86
  87
  88
  89 };
  90
  91
  92
  93
  94
  95
  96
  97 #endif // _Expr_Tanh_HeaderFile