[occt.git] / src / AdvApprox / AdvApprox_ApproxAFunction.cdl

-- Created on: 1995-05-29
-- Created by: Xavier BENVENISTE
-- Copyright (c) 1995-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.

class ApproxAFunction from AdvApprox 
    ---Purpose:
    -- this approximate a given function
uses Array1OfInteger   from TColStd,
     Vector            from math,
     HArray1OfInteger  from TColStd,
     Array1OfReal      from TColStd,
     Array1OfPnt2d     from TColgp,
     Array1OfPnt       from TColgp,
     HArray1OfReal     from TColStd,
     HArray1OfPnt2d    from TColgp,
     HArray1OfPnt      from TColgp,
     HArray2OfReal     from TColStd,
     HArray2OfPnt2d    from TColgp,
     HArray2OfPnt      from TColgp,
     Pnt               from gp,
     Pnt2d             from gp,
     Shape             from GeomAbs,
     EvaluatorFunction from AdvApprox,
     Cutting           from AdvApprox
     
raises 

    OutOfRange        from Standard,
    ConstructionError from Standard

is   
    Create(Num1DSS    : Integer ;
    	   Num2DSS    : Integer ;
	   Num3DSS    : Integer ;
	   OneDTol    : HArray1OfReal from TColStd ;
	   TwoDTol    : HArray1OfReal from TColStd ;
	   ThreeDTol  : HArray1OfReal from TColStd ;
	   First      : Real ;
	   Last       : Real ;
	   Continuity : Shape from GeomAbs ;
	   MaxDeg     : Integer ;
	   MaxSeg     : Integer ;
	   Func       : EvaluatorFunction from AdvApprox) 
	   
    returns ApproxAFunction from AdvApprox 
    raises ConstructionError; 
   
    ---Purpose: Constructs approximator tool.
    --
    --  Warning:
    --     the Func should be valid reference to object of type 
    --     inherited from class EvaluatorFunction from Approx 
    --     with life time longer than that of the approximator tool;
    --     
    --	  the result should be formatted in the following way :
    -- <--Num1DSS--> <--2 * Num2DSS--> <--3 * Num3DSS-->
    -- R[0] ....     R[Num1DSS].....                   R[Dimension-1] 
    --
    --  the order in which each Subspace appears should be consistent
    --  with the tolerances given in the create function and the
    --  results will be given in that order as well that is :
    --  Curve2d(n)  will correspond to the nth entry
    --  described by Num2DSS, Curve(n) will correspond to
    --  the nth entry described by Num3DSS 
    --  The same type of schema applies to the Poles1d, Poles2d and 
    --  Poles.


    Create(Num1DSS    : Integer ;
    	   Num2DSS    : Integer ;
	   Num3DSS    : Integer ;
	   OneDTol    : HArray1OfReal from TColStd ;
	   TwoDTol    : HArray1OfReal from TColStd ;
	   ThreeDTol  : HArray1OfReal from TColStd ;
	   First      : Real ;
	   Last       : Real ;
	   Continuity : Shape from GeomAbs ;
	   MaxDeg     : Integer ;
	   MaxSeg     : Integer ;
	   Func       : EvaluatorFunction from AdvApprox;
           CutTool    : Cutting from AdvApprox)
	   
      ---Purpose: Approximation with user methode of cutting

      returns ApproxAFunction from AdvApprox 
      raises ConstructionError;

    Perform(me:in out; 
            Num1DSS    : Integer ;
    	    Num2DSS    : Integer ;
	    Num3DSS    : Integer ;
    	    CutTool    : Cutting from AdvApprox) 
	    is private;
    	    
    Approximation(myclass; 
                  TotalDimension  : Integer; 
    	    	  TotalNumSS      : Integer;
		  LocalDimension  : Array1OfInteger;
		  First           : Real;
	          Last            : Real;
	          Evaluator       : in out EvaluatorFunction;
		  CutTool         : Cutting from AdvApprox;
	          ContinuityOrder : Integer; 
    	    	  NumMaxCoeffs    : Integer; 
    	    	  MaxSegments     : Integer;   
	          TolerancesArray : Array1OfReal;
	          code_precis     : Integer;
	          NumCurves       : in out Integer;
	          NumCoeffPerCurveArray : in out Array1OfInteger;
	          LocalCoefficientArray : in out Array1OfReal;
	          IntervalsArray        : in out Array1OfReal; 
	          ErrorMaxArray         : in out Array1OfReal;
	          AverageErrorArray     : in out Array1OfReal;
	          ErrorCode             : in out Integer);
    
     
    IsDone(me) returns Boolean 
    ---C++: inline
    ;
    --  True if the approximation succeeded within the imposed
    --  tolerances 
    HasResult(me) returns Boolean 
    ---C++: inline
    ;
    -- True if the approximation did come out with a result that
    --  is not NECESSARELY within the required tolerance
    --  
    Poles1d (me) 
    ---C++: inline 
    ---Purpose: returns the poles from the algorithms as is 
    returns HArray2OfReal from TColStd ;
    
    Poles2d (me) 
    ---Purpose: returns the poles from the algorithms as is
    ---C++: inline 
    returns HArray2OfPnt2d from TColgp ;

    Poles   (me) 
    ---Purpose: -- returns the poles from the algorithms as is 
    ---C++: inline 
    returns  HArray2OfPnt from TColgp ;
    
    NbPoles(me) returns Integer 
    ---Purpose:  as the name says
    ;

    Poles1d (me; Index : Integer ;
   		 P : in out Array1OfReal from TColStd) 
    ---Purpose: returns the poles at Index from the 1d subspace
    raises OutOfRange ;

    
    Poles2d (me; Index : Integer ;
   		 P : in out Array1OfPnt2d from TColgp) 
    ---Purpose:  returns the poles at Index from the 2d subspace
    raises OutOfRange ;
    
    Poles   (me; Index : Integer ;
   		 P : in out Array1OfPnt from TColgp) 
 
    ---Purpose:  returns the poles at Index from the 3d subspace
    raises OutOfRange ;
    
    Degree(me)  returns Integer 
    ---C++: inline
    ;
    
    NbKnots(me) returns Integer 
    ---C++: inline
    ;
    NumSubSpaces(me; Dimension : Integer) returns Integer 
    ---C++: inline
    ; 
    Knots(me) 
    ---C++: inline
    returns HArray1OfReal    from TColStd ;
    
    Multiplicities(me) 
    ---C++: inline
    returns HArray1OfInteger from TColStd ;
    
    MaxError    (me; Dimension : Integer)
    ---Purpose:  returns the error as is in the algorithms
    returns HArray1OfReal from TColStd ;
    
    AverageError(me; Dimension : Integer)

    ---Purpose: returns the error as is in the algorithms
    returns HArray1OfReal from TColStd ;
    
    MaxError (me; Dimension : Integer ;
   		  Index : Integer)    returns Real 
    ;
    
    AverageError(me; Dimension : Integer;
    	    	    Index : Integer) returns Real 
    ;
    
        
    Dump(me; o: in out OStream);
    ---Purpose: diplay information on approximation.

fields
    -- Input fields 
    -- 
    myNumSubSpaces : Integer[3] ;
    -- Number of subspaces [0] = number of 1 dimensional subspaces
    --                     [1] = number of 2 dimensional subspaces
    --                     [2] = number of 3 dimensional subspaces
    
    my1DTolerances   : HArray1OfReal from TColStd ;
    my2DTolerances   : HArray1OfReal from TColStd ;
    my3DTolerances   : HArray1OfReal from TColStd ;

    --     -- self explanatory : one tolerance per subspace 
    myFirst          : Real ;
    -- first parameter for the approximation
    myLast           : Real ;
    -- last parameter for the approximation 
    myContinuity     : Shape from GeomAbs ;
    
    -- continuity requested for the approximation
    ---Warning:
    --   The evaluator of the function to approximate
    --   must provide the derivatives up to the requested
    --   order otherwise this will NOT WORK
    myMaxDegree      : Integer ;
    -- maximum degree for the approximation
     ---Warning:
    --   Because of the unstable evaluation after degree 14
    --   this is limited to 14
    myMaxSegments    : Integer ;
    -- maximum of segment allowed 
    -- Output fields 
    -- 
    myDone           : Boolean ;
    -- tells if the approximation succeeded within the requested
    -- tolerance
    myHasResult      : Boolean ;
    -- tells if the approximation returned a result although
    -- it might not be within the requested tolerance. In
    -- that case myDone will be false
    -- 
    my1DPoles        : HArray2OfReal     from TColStd ;
    -- 1D poles if myNumSubSpaces[0] > 0
    my2DPoles        : HArray2OfPnt2d    from TColgp  ;
    -- 2D poles if myNumSubSpaces[1] > 0 
    my3DPoles        : HArray2OfPnt      from TColgp ;
    -- 3D poles if myNumSubSpaces[2] > 0
    myKnots          : HArray1OfReal     from TColStd ;
    myMults          : HArray1OfInteger  from TColStd ;
    myDegree         : Integer ;
    
    myEvaluator      : Address from Standard;   
    -- 
    -- The Errors 
    -- 
    my1DMaxError     : HArray1OfReal     from TColStd ;
    my1DAverageError : HArray1OfReal     from TColStd ;
    my2DMaxError     : HArray1OfReal     from TColStd ;
    my2DAverageError : HArray1OfReal     from TColStd ;
    my3DMaxError     : HArray1OfReal     from TColStd ;
    my3DAverageError : HArray1OfReal     from TColStd ;
    
end ApproxAFunction ;
Commit	Line	Data
b311480e	1	-- Created on: 1995-05-29
	2	-- Created by: Xavier BENVENISTE
	3	-- Copyright (c) 1995-1999 Matra Datavision
973c2be1	4	-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e	5	--
973c2be1	6	-- This file is part of Open CASCADE Technology software library.
b311480e	7	--
d5f74e42	8	-- This library is free software; you can redistribute it and/or modify it under
d5f74e42	9	-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1	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.
b311480e	13	--
973c2be1	14	-- Alternatively, this file may be used under the terms of Open CASCADE
973c2be1	15	-- commercial license or contractual agreement.
7fd59977	16
7fd59977	17	class ApproxAFunction from AdvApprox
ff8178ef	18	---Purpose:
ff8178ef	19	-- this approximate a given function
7fd59977	20	uses Array1OfInteger from TColStd,
	21	Vector from math,
	22	HArray1OfInteger from TColStd,
	23	Array1OfReal from TColStd,
	24	Array1OfPnt2d from TColgp,
	25	Array1OfPnt from TColgp,
	26	HArray1OfReal from TColStd,
	27	HArray1OfPnt2d from TColgp,
	28	HArray1OfPnt from TColgp,
	29	HArray2OfReal from TColStd,
	30	HArray2OfPnt2d from TColgp,
	31	HArray2OfPnt from TColgp,
	32	Pnt from gp,
	33	Pnt2d from gp,
	34	Shape from GeomAbs,
	35	EvaluatorFunction from AdvApprox,
	36	Cutting from AdvApprox
	37
	38	raises
	39
	40	OutOfRange from Standard,
	41	ConstructionError from Standard
	42
	43	is
	44	Create(Num1DSS : Integer ;
	45	Num2DSS : Integer ;
	46	Num3DSS : Integer ;
	47	OneDTol : HArray1OfReal from TColStd ;
	48	TwoDTol : HArray1OfReal from TColStd ;
	49	ThreeDTol : HArray1OfReal from TColStd ;
	50	First : Real ;
	51	Last : Real ;
	52	Continuity : Shape from GeomAbs ;
	53	MaxDeg : Integer ;
	54	MaxSeg : Integer ;
	55	Func : EvaluatorFunction from AdvApprox)
	56
	57	returns ApproxAFunction from AdvApprox
	58	raises ConstructionError;
	59
	60	---Purpose: Constructs approximator tool.
	61	--
	62	-- Warning:
	63	-- the Func should be valid reference to object of type
	64	-- inherited from class EvaluatorFunction from Approx
	65	-- with life time longer than that of the approximator tool;
	66	--
	67	-- the result should be formatted in the following way :
	68	-- <--Num1DSS--> <--2 * Num2DSS--> <--3 * Num3DSS-->
	69	-- R[0] .... R[Num1DSS]..... R[Dimension-1]
	70	--
	71	-- the order in which each Subspace appears should be consistent
	72	-- with the tolerances given in the create function and the
	73	-- results will be given in that order as well that is :
	74	-- Curve2d(n) will correspond to the nth entry
	75	-- described by Num2DSS, Curve(n) will correspond to
	76	-- the nth entry described by Num3DSS
	77	-- The same type of schema applies to the Poles1d, Poles2d and
	78	-- Poles.
	79
	80
	81	Create(Num1DSS : Integer ;
	82	Num2DSS : Integer ;
	83	Num3DSS : Integer ;
84	OneDTol : HArray1OfReal from TColStd ;
85	TwoDTol : HArray1OfReal from TColStd ;
86	ThreeDTol : HArray1OfReal from TColStd ;
87	First : Real ;
88	Last : Real ;
89	Continuity : Shape from GeomAbs ;
90	MaxDeg : Integer ;
91	MaxSeg : Integer ;
92	Func : EvaluatorFunction from AdvApprox;
93	CutTool : Cutting from AdvApprox)
94
95	---Purpose: Approximation with user methode of cutting
96
97	returns ApproxAFunction from AdvApprox
98	raises ConstructionError;
99
100	Perform(me:in out;
101	Num1DSS : Integer ;
102	Num2DSS : Integer ;
103	Num3DSS : Integer ;
104	CutTool : Cutting from AdvApprox)
105	is private;
106
107	Approximation(myclass;
108	TotalDimension : Integer;
109	TotalNumSS : Integer;
110	LocalDimension : Array1OfInteger;
111	First : Real;
112	Last : Real;
113	Evaluator : in out EvaluatorFunction;
114	CutTool : Cutting from AdvApprox;
115	ContinuityOrder : Integer;
116	NumMaxCoeffs : Integer;
117	MaxSegments : Integer;
118	TolerancesArray : Array1OfReal;
119	code_precis : Integer;
120	NumCurves : in out Integer;
121	NumCoeffPerCurveArray : in out Array1OfInteger;
122	LocalCoefficientArray : in out Array1OfReal;
123	IntervalsArray : in out Array1OfReal;
124	ErrorMaxArray : in out Array1OfReal;
125	AverageErrorArray : in out Array1OfReal;
126	ErrorCode : in out Integer);
127
128
129	IsDone(me) returns Boolean
130	---C++: inline
131	;
132	-- True if the approximation succeeded within the imposed
133	-- tolerances
134	HasResult(me) returns Boolean
135	---C++: inline
136	;
137	-- True if the approximation did come out with a result that
138	-- is not NECESSARELY within the required tolerance
139	--
140	Poles1d (me)
141	---C++: inline
142	---Purpose: returns the poles from the algorithms as is
143	returns HArray2OfReal from TColStd ;
144
145	Poles2d (me)
146	---Purpose: returns the poles from the algorithms as is
147	---C++: inline
148	returns HArray2OfPnt2d from TColgp ;
149
150	Poles (me)
151	---Purpose: -- returns the poles from the algorithms as is
152	---C++: inline
153	returns HArray2OfPnt from TColgp ;
154
155	NbPoles(me) returns Integer
156	---Purpose: as the name says
157	;
158
159	Poles1d (me; Index : Integer ;
160	P : in out Array1OfReal from TColStd)
161	---Purpose: returns the poles at Index from the 1d subspace
162	raises OutOfRange ;
163
164
165	Poles2d (me; Index : Integer ;
166	P : in out Array1OfPnt2d from TColgp)
167	---Purpose: returns the poles at Index from the 2d subspace
168	raises OutOfRange ;
169
170	Poles (me; Index : Integer ;
171	P : in out Array1OfPnt from TColgp)
172
173	---Purpose: returns the poles at Index from the 3d subspace
174	raises OutOfRange ;
175
176	Degree(me) returns Integer
177	---C++: inline
178	;
179
180	NbKnots(me) returns Integer
181	---C++: inline
182	;
183	NumSubSpaces(me; Dimension : Integer) returns Integer
184	---C++: inline
185	;
186	Knots(me)
187	---C++: inline
188	returns HArray1OfReal from TColStd ;
189
190	Multiplicities(me)
191	---C++: inline
192	returns HArray1OfInteger from TColStd ;
193
194	MaxError (me; Dimension : Integer)
195	---Purpose: returns the error as is in the algorithms
196	returns HArray1OfReal from TColStd ;
197
198	AverageError(me; Dimension : Integer)
199
200	---Purpose: returns the error as is in the algorithms
201	returns HArray1OfReal from TColStd ;
202
203	MaxError (me; Dimension : Integer ;
204	Index : Integer) returns Real
205	;
206
207	AverageError(me; Dimension : Integer;
208	Index : Integer) returns Real
209	;
210
211
212	Dump(me; o: in out OStream);
213	---Purpose: diplay information on approximation.
214
215	fields
216	-- Input fields
217	--
218	myNumSubSpaces : Integer[3] ;
219	-- Number of subspaces [0] = number of 1 dimensional subspaces
220	-- [1] = number of 2 dimensional subspaces
221	-- [2] = number of 3 dimensional subspaces
222
223	my1DTolerances : HArray1OfReal from TColStd ;
224	my2DTolerances : HArray1OfReal from TColStd ;
225	my3DTolerances : HArray1OfReal from TColStd ;
226
227	-- -- self explanatory : one tolerance per subspace
228	myFirst : Real ;
229	-- first parameter for the approximation
230	myLast : Real ;
231	-- last parameter for the approximation
232	myContinuity : Shape from GeomAbs ;
233
234	-- continuity requested for the approximation
235	---Warning:
236	-- The evaluator of the function to approximate
237	-- must provide the derivatives up to the requested
238	-- order otherwise this will NOT WORK
239	myMaxDegree : Integer ;
240	-- maximum degree for the approximation
241	---Warning:
242	-- Because of the unstable evaluation after degree 14
243	-- this is limited to 14
244	myMaxSegments : Integer ;
245	-- maximum of segment allowed
246	-- Output fields
247	--
248	myDone : Boolean ;
249	-- tells if the approximation succeeded within the requested
250	-- tolerance
251	myHasResult : Boolean ;
252	-- tells if the approximation returned a result although
253	-- it might not be within the requested tolerance. In
254	-- that case myDone will be false
255	--
256	my1DPoles : HArray2OfReal from TColStd ;
257	-- 1D poles if myNumSubSpaces[0] > 0
258	my2DPoles : HArray2OfPnt2d from TColgp ;
259	-- 2D poles if myNumSubSpaces[1] > 0
260	my3DPoles : HArray2OfPnt from TColgp ;
261	-- 3D poles if myNumSubSpaces[2] > 0
262	myKnots : HArray1OfReal from TColStd ;
263	myMults : HArray1OfInteger from TColStd ;
264	myDegree : Integer ;
265
266	myEvaluator : Address from Standard;
267	--
268	-- The Errors
269	--
270	my1DMaxError : HArray1OfReal from TColStd ;
271	my1DAverageError : HArray1OfReal from TColStd ;
272	my2DMaxError : HArray1OfReal from TColStd ;
273	my2DAverageError : HArray1OfReal from TColStd ;
274	my3DMaxError : HArray1OfReal from TColStd ;
275	my3DAverageError : HArray1OfReal from TColStd ;
276
277	end ApproxAFunction ;