src/LProp/LProp_FuncCurExt.cdl

   1 -- Created on: 1994-09-02
   2 -- Created by: Yves FRICAUD
   3 -- Copyright (c) 1994-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
   9 -- under the terms of the GNU Lesser General Public 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 private generic class FuncCurExt from LProp (Curve as any;
  18                                              Vec   as any; -- as Vec or Vec2d
  19                                              Pnt   as any; -- as Pnt or Pnt2d
  20                                              Dir   as any; -- as Dir or Dir2d Vec
  21                                              Tool  as any) -- as Tool(Curve, Pnt, Vec)
  22 inherits FunctionWithDerivative from math
  23         ---Purpose: Function used to find the extremas of curvature in 2d.
  24
  25 is
  26     Create ( C : Curve ; Tol : Real) returns FuncCurExt from LProp;
  27
  28     Value (me : in out; X : Real; F : out Real)
  29         ---Purpose: Returns the value for the variable <X>.
  30     returns Boolean;
  31
  32     Derivative (me : in out; X : Real; D : out Real)
  33         ---Purpose: Returns the derivative for the variable <X>.
  34     returns Boolean;
  35
  36     Values (me : in out ; X  : Real; F  : out Real; D  : out Real)
  37         ---Purpose: Returns the value of the function and the derivative
  38         --          for the variable <X>.
  39     returns Boolean;
  40
  41     IsMinKC (me ; Param : Real)
  42         ---Purpose: True  if  Param  corresponds  to  a minus
  43         --          of the radius of curvature.
  44     returns Boolean;
  45
  46 fields
  47     theCurve : Curve;
  48     epsX     : Real from Standard;
  49
  50 end FuncCurExt;
  51