0024624: Lost word in license statement in source files
[occt.git] / src / AppParCurves / AppParCurves_Projection.cdl
1 -- Created on: 1993-06-24
2 -- Created by: Modelistation
3 -- Copyright (c) 1993-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 under
9 -- the terms of the GNU Lesser General Public License 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 generic class Projection from AppParCurves
18                     (MultiLine   as any;
19                      ToolLine    as any)   -- as ToolLine(MultiLine)
20
21
22     ---Purpose: This algorithm uses the algorithms LeastSquare, 
23     --          ResConstraint and a Projection method to approximate a set 
24     --          of points (AppDef_MultiLine) with a minimization of the
25     --          sum(square(|F(i)-Qi|)) by changing the parameter. 
26
27
28
29 uses Vector                    from math, 
30      MultiCurve                from AppParCurves,
31      HArray1OfConstraintCouple from AppParCurves
32
33
34 raises OutOfRange from Standard,
35        NotDone    from StdFail
36
37
38 private class ProLeastSquare instantiates LeastSquare from AppParCurves
39         (MultiLine, ToolLine);
40         
41 private class ProConstraint instantiates ResolConstraint from AppParCurves
42         (MultiLine, ToolLine);
43
44 private class ProFunction instantiates Function from AppParCurves
45         (MultiLine, ToolLine, ProLeastSquare, ProConstraint);
46
47
48 is
49
50     Create(SSP: MultiLine; FirstPoint, LastPoint: Integer;
51            TheConstraints: HArray1OfConstraintCouple;
52            Parameters: in out Vector; Deg: Integer; 
53            Tol3d, Tol2d: Real; NbIterations: Integer = 200)
54         ---Purpose: Tries to minimize the sum (square(||Qui - Bi*Pi||)) 
55         --          where Pui describe the approximating Bezier curves'Poles 
56         --          and Qi the MultiLine points with a parameter ui.
57         --          In this algorithm, the parameters ui are the unknowns.
58         --          The tolerance required on this sum is given by Tol.
59         --          The desired degree of the resulting curve is Deg.
60         --          SSP is returned with the new parameter.
61
62     returns Projection from AppParCurves;
63     
64     
65     IsDone(me)
66         ---Purpose: returns True if all has been correctly done.        
67
68     returns Boolean
69     is static;
70     
71     
72     Value(me)
73         ---Purpose: returns all the Bezier curves approximating the
74         --          MultiLine SSP after minimization of the parameter.
75
76     returns MultiCurve from AppParCurves
77     raises NotDone from StdFail
78     is static;
79     
80     
81     Error(me; Index: Integer)
82         ---Purpose: returns the difference between the old and the new 
83         --          approximation.
84         --          An exception is raised if NotDone.
85         --          An exception is raised if Index<1 or Index>NbParameters.
86
87     returns Real
88     raises NotDone from StdFail,
89            OutOfRange from Standard
90     is static;
91     
92
93     MaxError3d(me)
94         ---Purpose: returns the maximum difference between the old and the 
95         --          new approximation.
96
97     returns Real
98     raises NotDone from StdFail
99     is static;
100
101
102     MaxError2d(me)
103         ---Purpose: returns the maximum difference between the old and the 
104         --          new approximation.
105
106     returns Real
107     raises NotDone from StdFail
108     is static;
109
110
111     AverageError(me)
112        ---Purpose: returns the average error between the old and the
113        --          new approximation.
114
115     returns Real
116     raises NotDone from StdFail
117     is static;
118
119
120 fields
121
122 SCU:          MultiCurve from AppParCurves;
123 ParError:     Vector from math;
124 AvError:      Real;
125 MError3d:     Real;
126 MError2d:     Real;
127 Done:         Boolean;
128
129 end Projection from AppParCurves;