src/Expr/Expr_FunctionDerivative.cdl

   1 -- File:        FunctionDerivative.cdl
   2 -- Created:     Mon Jan 14 10:53:24 1991
   3 -- Author:      Arnaud BOUZY
   4 --              <adn@topsn3>
   5 ---Copyright:    Matra Datavision 1991, 1992
   6
   7 class FunctionDerivative from Expr
   8
   9 inherits GeneralFunction from Expr
  10
  11 uses NamedUnknown from Expr,
  12     GeneralExpression from Expr,
  13     Array1OfNamedUnknown from Expr,
  14     Array1OfReal from TColStd,
  15     AsciiString from TCollection
  16
  17 raises OutOfRange from Standard,
  18     DimensionMismatch from Standard,
  19     NumericError from Standard,
  20     NotEvaluable from Expr
  21
  22 is
  23
  24     Create(func : GeneralFunction; withX : NamedUnknown; deg : Integer)
  25     ---Purpose: Creates a FunctionDerivative of degree <deg> relative
  26     --          to the <withX> variable.
  27     --          Raises OutOfRange if <deg> lower or equal to zero.
  28     ---Level : Advanced
  29     returns mutable FunctionDerivative
  30     raises OutOfRange;
  31
  32     NbOfVariables(me)
  33     ---Purpose: Returns the number of variables of <me>.
  34     returns Integer;
  35
  36     Variable(me; index : Integer)
  37     ---Purpose: Returns the variable denoted by <index> in <me>.
  38     --          Raises OutOfRange if <index> greater than
  39     --          NbOfVariables of <me>.
  40     returns NamedUnknown
  41     raises OutOfRange;
  42
  43     Evaluate(me; vars : Array1OfNamedUnknown;
  44                 values : Array1OfReal)
  45     ---Purpose: Computes the value of <me> with the given variables.
  46     --          Raises DimensionMismatch if Length(vars) is different from
  47     --          Length(values).
  48     returns Real
  49     raises DimensionMismatch, NumericError,NotEvaluable;
  50
  51     Copy(me)
  52     ---Purpose: Returns a copy of <me> with the same form.
  53     returns mutable like me;
  54
  55     Derivative(me; var : NamedUnknown)
  56     ---Purpose: Returns Derivative of <me> for variable <var>.
  57     returns GeneralFunction;
  58
  59     Derivative(me; var : NamedUnknown; deg : Integer)
  60     ---Purpose: Returns Derivative of <me> for variable <var> with
  61     --          degree <deg>.
  62     returns GeneralFunction;
  63
  64     IsIdentical(me; func : GeneralFunction)
  65     ---Purpose: Tests if <me> and <func> are similar functions (same
  66     --          name and same used expression).
  67     returns Boolean;
  68
  69     IsLinearOnVariable(me; index : Integer)
  70     ---Purpose: Tests if <me> is linear on variable on range <index>
  71     returns Boolean;
  72
  73     Function(me)
  74     ---Purpose: Returns the function of which <me> is the derivative.
  75     ---Level : Internal
  76     returns GeneralFunction
  77     is static;
  78
  79     Degree(me)
  80     ---Purpose: Returns the degree of derivation of <me>.
  81     ---Level : Internal
  82     returns Integer
  83     is static;
  84
  85     DerivVariable(me)
  86     ---Purpose: Returns the derivation variable of <me>.
  87     ---Level : Internal
  88     returns NamedUnknown
  89     is static;
  90
  91     GetStringName(me)
  92     returns AsciiString;
  93
  94     Expression(me)
  95     returns GeneralExpression
  96     ---Level : Internal
  97     is static;
  98
  99     UpdateExpression(me: mutable);
 100     ---Level : Internal
 101
 102 fields
 103
 104     myFunction : GeneralFunction;
 105     myExp : GeneralExpression;
 106     myDerivate : NamedUnknown;
 107     myDegree : Integer;
 108
 109 friends
 110
 111     class NamedFunction from Expr
 112
 113 end FunctionDerivative;
 114
 115