src/GccIter/GccIter_FunctionTanCuCu.cdl

   1 -- File:        FunctionTanCuCu.cdl
   2 -- Created:     Thu Feb 20 7:33:43 1992
   3 -- Author:      Remy GILET
   4 --              <reg@topsn3>
   5 ---Copyright:    Matra Datavision 1992
   6
   7
   8 generic class FunctionTanCuCu from GccIter (
   9     TheCurve     as any;
  10     TheCurveTool as any) -- as CurvePGTool from GccInt (TheCurve)
  11
  12 inherits FunctionSetWithDerivatives from math
  13
  14     ---Purpose: This abstract class describes a Function of 1 Variable
  15     --          used to find a line tangent to two curves.
  16
  17 uses Vector from math,
  18      Matrix from math,
  19      Circ2d from gp,
  20      Pnt2d  from gp,
  21      Vec2d  from gp,
  22      Type3  from GccIter
  23
  24
  25 raises ConstructionError
  26
  27 is
  28
  29 Create (Curv1 : TheCurve ;
  30         Curv2 : TheCurve ) returns FunctionTanCuCu from GccIter;
  31
  32 Create (Circ1 : Circ2d   from gp ;
  33         Curv2 : TheCurve         ) returns FunctionTanCuCu from GccIter;
  34
  35 InitDerivative(me                   : in out                      ;
  36                X                    :        Vector from math     ;
  37                Point1,Point2        :    out Pnt2d  from gp       ;
  38                Tan1,Tan2,D21,D22    :    out Vec2d  from gp       )
  39 raises ConstructionError
  40 is static;
  41
  42 NbVariables(me) returns Integer;
  43     ---Purpose: returns the number of variables of the function.
  44
  45 NbEquations(me) returns Integer;
  46     ---Purpose: returns the number of equations of the function.
  47
  48 Value (me : in out                 ;
  49        X  :        Vector from math;
  50        F  :    out Vector from math) returns Boolean;
  51     ---Purpose: Computes the value of the function F for the variable X.
  52     --          It returns True if the computation is successfully done,
  53     --          False otherwise.
  54
  55 Derivatives (me    : in out                 ;
  56              X     :        Vector from math;
  57              Deriv :    out Matrix from math) returns Boolean;
  58     ---Purpose: Computes the derivative of the function F for the variable X.
  59     --          It returns True if the computation is successfully done,
  60     --          False otherwise.
  61
  62 Values (me    : in out                 ;
  63         X     :        Vector from math;
  64         F     : out    Vector from math;
  65         Deriv : out    Matrix from math) returns Boolean;
  66     ---Purpose: Computes the value and the derivative of the function F
  67     --          for the variable X.
  68     --          It returns True if the computation is successfully done,
  69     --          False otherwise.
  70
  71 fields
  72
  73 TheCurve1     : TheCurve               ;
  74 TheCurve2     : TheCurve               ;
  75 TheCirc1      : Circ2d   from gp       ;
  76 TheType       : Type3    from GccIter  ;
  77
  78 end FunctionTanCuCu;
  79
  80
  81