src/GeomInt/GeomInt_MyGradientOfTheComputeLineBezierOfWLApprox.hxx

   1 // Created on: 1995-01-27
   2 // Created by: Jacques GOUSSARD
   3 // Copyright (c) 1995-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 #ifndef _GeomInt_MyGradientOfTheComputeLineBezierOfWLApprox_HeaderFile
  18 #define _GeomInt_MyGradientOfTheComputeLineBezierOfWLApprox_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <AppParCurves_MultiCurve.hxx>
  25 #include <math_Vector.hxx>
  26 #include <Standard_Real.hxx>
  27 #include <Standard_Boolean.hxx>
  28 #include <Standard_Integer.hxx>
  29 #include <AppParCurves_HArray1OfConstraintCouple.hxx>
  30 class Standard_OutOfRange;
  31 class StdFail_NotDone;
  32 class GeomInt_TheMultiLineOfWLApprox;
  33 class GeomInt_TheMultiLineToolOfWLApprox;
  34 class GeomInt_ParLeastSquareOfMyGradientOfTheComputeLineBezierOfWLApprox;
  35 class GeomInt_ResConstraintOfMyGradientOfTheComputeLineBezierOfWLApprox;
  36 class GeomInt_ParFunctionOfMyGradientOfTheComputeLineBezierOfWLApprox;
  37 class GeomInt_Gradient_BFGSOfMyGradientOfTheComputeLineBezierOfWLApprox;
  38 class AppParCurves_MultiCurve;
  39
  40
  41
  42 class GeomInt_MyGradientOfTheComputeLineBezierOfWLApprox
  43 {
  44 public:
  45
  46   DEFINE_STANDARD_ALLOC
  47
  48
  49   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
  50   //! where Pui describe the approximating Bezier curves'Poles
  51   //! and Qi the MultiLine points with a parameter ui.
  52   //! In this algorithm, the parameters ui are the unknowns.
  53   //! The tolerance required on this sum is given by Tol.
  54   //! The desired degree of the resulting curve is Deg.
  55   Standard_EXPORT GeomInt_MyGradientOfTheComputeLineBezierOfWLApprox(const GeomInt_TheMultiLineOfWLApprox& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, math_Vector& Parameters, const Standard_Integer Deg, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer NbIterations = 200);
  56
  57   //! returns True if all has been correctly done.
  58   Standard_EXPORT Standard_Boolean IsDone() const;
  59
  60   //! returns all the Bezier curves approximating the
  61   //! MultiLine SSP after minimization of the parameter.
  62   Standard_EXPORT AppParCurves_MultiCurve Value() const;
  63
  64   //! returns the difference between the old and the new
  65   //! approximation.
  66   //! An exception is raised if NotDone.
  67   //! An exception is raised if Index<1 or Index>NbParameters.
  68   Standard_EXPORT Standard_Real Error (const Standard_Integer Index) const;
  69
  70   //! returns the maximum difference between the old and the
  71   //! new approximation.
  72   Standard_EXPORT Standard_Real MaxError3d() const;
  73
  74   //! returns the maximum difference between the old and the
  75   //! new approximation.
  76   Standard_EXPORT Standard_Real MaxError2d() const;
  77
  78   //! returns the average error between the old and the
  79   //! new approximation.
  80   Standard_EXPORT Standard_Real AverageError() const;
  81
  82
  83
  84
  85 protected:
  86
  87
  88
  89
  90
  91 private:
  92
  93
  94
  95   AppParCurves_MultiCurve SCU;
  96   math_Vector ParError;
  97   Standard_Real AvError;
  98   Standard_Real MError3d;
  99   Standard_Real MError2d;
 100   Standard_Boolean Done;
 101
 102
 103 };
 104
 105
 106
 107
 108
 109
 110
 111 #endif // _GeomInt_MyGradientOfTheComputeLineBezierOfWLApprox_HeaderFile