src/Expr/Expr_Tanh.cdl

   1 -- Created on: 1991-01-14
   2 -- Created by: Arnaud BOUZY
   3 -- Copyright (c) 1991-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22 class Tanh from Expr
  23
  24 inherits UnaryExpression from Expr
  25
  26 uses GeneralExpression from Expr,
  27     AsciiString from TCollection,
  28     Array1OfNamedUnknown from Expr,
  29     Array1OfReal from TColStd,
  30     NamedUnknown from Expr
  31
  32 raises NumericError from Standard,
  33     NotEvaluable from Expr
  34
  35 is
  36
  37     Create(exp : GeneralExpression)
  38     ---Purpose: Creates the hyperbolic tangent of <exp>.
  39     returns mutable Tanh;
  40
  41     ShallowSimplified(me)
  42     ---Purpose: Returns a GeneralExpression after a simplification
  43     --          of the arguments of <me>.
  44     returns any GeneralExpression
  45     raises NumericError;
  46
  47     Copy(me)
  48     ---Purpose: Returns a copy of <me> having the same unknowns and functions.
  49     returns mutable like me;
  50
  51     IsIdentical(me; Other : GeneralExpression)
  52     ---Purpose: Tests if <me> and <Other> define the same expression.
  53     --          This method does not include any simplification before
  54     --          testing.
  55     returns Boolean;
  56
  57     IsLinear(me)
  58     returns Boolean;
  59
  60     Derivative(me; X : NamedUnknown)
  61     ---Purpose: Returns the derivative on <X> unknown of <me>
  62     returns any GeneralExpression;
  63
  64     Evaluate(me; vars : Array1OfNamedUnknown; vals : Array1OfReal)
  65     ---Purpose: 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     returns Real
  70     raises NotEvaluable,NumericError;
  71
  72     String(me)
  73     ---Purpose: returns a string representing <me> in a readable way.
  74     returns AsciiString;
  75
  76 end Tanh;