0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / AppParCurves / AppParCurves_Function.cdl
diff --git a/src/AppParCurves/AppParCurves_Function.cdl b/src/AppParCurves/AppParCurves_Function.cdl
deleted file mode 100644 (file)
index afdd105..0000000
+++ /dev/null
@@ -1,177 +0,0 @@
--- Created on: 1991-09-20
--- Created by: Laurent PAINNOT
--- Copyright (c) 1991-1999 Matra Datavision
--- Copyright (c) 1999-2014 OPEN CASCADE SAS
---
--- This file is part of Open CASCADE Technology software library.
---
--- This library is free software; you can redistribute it and/or modify it under
--- the terms of the GNU Lesser General Public License version 2.1 as published
--- by the Free Software Foundation, with special exception defined in the file
--- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
--- distribution for complete text of the license and disclaimer of any warranty.
---
--- Alternatively, this file may be used under the terms of Open CASCADE
--- commercial license or contractual agreement.
-
-generic class Function from AppParCurves (
-                             MultiLine  as any;
-                             ToolLine   as any; -- as ToolLine(MultiLine)
-                             Squares    as any;
-                             ResolCons  as any)
-
-    inherits MultipleVarFunctionWithGradient from math
-
-    ---Purpose: This function inherits MultipleVarFunctionWithGradient to be 
-    --          used in the mathematical algorithm BFGS.
-    --          It computes the value of the function 
-    --          F=sum(||Qui - B*Pi||)2 where Pi are Poles of the Bezier curves 
-    --          approximating the given MultiLine SSP and ui the parameters 
-    --          associated to the points Qi of SSP.
-    --          It also computes the gradient for values ui of the parameter.
-
-
-uses MultiCurve                from AppParCurves, 
-     HArray1OfConstraintCouple from AppParCurves,
-     Constraint                from AppParCurves,
-     Vector                    from math, 
-     Matrix                    from math,
-     HArray1OfInteger          from TColStd
-
-is
-
-    Create(SSP: MultiLine; FirstPoint, LastPoint: Integer;
-          TheConstraints: HArray1OfConstraintCouple;
-          Parameters: Vector; Deg: Integer)
-       ---Purpose: initializes the fields of the function. The approximating
-       --          curve has the desired degree Deg.
-
-    returns Function from AppParCurves;
-    
-    
-    NbVariables(me)
-       ---Purpose: returns the number of variables of the function. It 
-       --          corresponds to the number of MultiPoints.
-
-    returns Integer
-    is static;
-    
-    
-
-    Perform(me: in out; X: Vector)
-       ---Purpose: this method is used each time Value or Gradient is
-       --           needed.
-    
-    is static protected;
-
-
-    Value(me: in out; X: Vector; F: out Real) 
-       ---Purpose: this method computes the new approximation of the 
-       --          MultiLine
-       --          SSP and calculates F = sum (||Pui - Bi*Pi||2) for each 
-       --          point of the MultiLine.
-    
-    returns Boolean
-    is static;
-
-
-    Gradient(me: in out; X: Vector; G: out Vector)
-       ---Purpose: returns the gradient G of the sum above for the 
-       --          parameters Xi.
-
-    returns Boolean
-    is static;
-    
-    
-    Values(me: in out; X: Vector; F: out Real; G: out Vector)
-       ---Purpose: returns the value F=sum(||Pui - Bi*Pi||)2.
-       --          returns the value G = grad(F) for the parameters Xi.
-
-    returns Boolean
-    is static;
-    
-    
-    
-    NewParameters(me)
-       ---Purpose: returns the new parameters of the MultiLine.
-       ---C++: return const&
-    returns Vector
-    is static;
-
-
-    CurveValue(me: in out)
-       ---Purpose: returns the MultiCurve approximating the set after
-       --          computing the value F or Grad(F).
-       ---C++: return const&
-    returns MultiCurve from AppParCurves
-    is static;
-    
-
-    Error(me; IPoint, CurveIndex: Integer)
-       ---Purpose: returns the distance between the MultiPoint of range 
-       --          IPoint and the curve CurveIndex.
-    
-    returns Real
-    is static;
-
-
-    MaxError3d(me)
-       ---Purpose: returns the maximum distance between the points
-       --          and the MultiCurve.
-
-    returns Real
-    is static;
-    
-    MaxError2d(me)
-       ---Purpose: returns the maximum distance between the points
-       --          and the MultiCurve.
-
-    returns Real
-    is static;
-
-    
-    FirstConstraint(me; TheConstraints: HArray1OfConstraintCouple;
-                   FirstPoint: Integer)
-       ---Purpose:
-
-    returns Constraint from AppParCurves
-    is static;
-    
-    
-    LastConstraint(me; TheConstraints: HArray1OfConstraintCouple;
-                  LastPoint: Integer)
-       ---Purpose:
-
-    returns Constraint from AppParCurves
-    is static;
-    
-    
-fields
-
-Done:           Boolean;
-MyMultiLine :   MultiLine;
-MyMultiCurve:   MultiCurve from AppParCurves;
-Degre:          Integer;
-myParameters:   Vector;
-FVal:           Real;
-ValGrad_F:      Vector from math;
-MyF:            Matrix from math;
-PTLX :          Matrix from math;
-PTLY :          Matrix from math;
-PTLZ :          Matrix from math;
-A:              Matrix from math;
-DA:             Matrix from math;
-MyLeastSquare : Squares;
-Contraintes:    Boolean;
-NbP:            Integer;
-NbCu:           Integer;
-Adeb:           Integer;
-Afin:           Integer;
-tabdim:         HArray1OfInteger from TColStd;
-ERR3d:          Real;
-ERR2d:          Real;
-FirstP:         Integer;
-LastP:          Integer;
-myConstraints:  HArray1OfConstraintCouple from AppParCurves;
-
-end Function;