include/opencascade/BRepApprox_MyGradientbisOfTheComputeLineOfApprox.hxx

0001 // Created on: 1995-06-06
0002 // Created by: Jean Yves LEBEY
0003 // Copyright (c) 1995-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile
0018 #define _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <AppParCurves_MultiCurve.hxx>
0025 #include <math_Vector.hxx>
0026 #include <Standard_Real.hxx>
0027 #include <Standard_Integer.hxx>
0028 #include <AppParCurves_ConstraintCouple.hxx>
0029 #include <NCollection_Array1.hxx>
0030 #include <NCollection_HArray1.hxx>
0031 class Standard_OutOfRange;
0032 class StdFail_NotDone;
0033 class BRepApprox_TheMultiLineOfApprox;
0034 class BRepApprox_TheMultiLineToolOfApprox;
0035 class BRepApprox_ParLeastSquareOfMyGradientbisOfTheComputeLineOfApprox;
0036 class BRepApprox_ResConstraintOfMyGradientbisOfTheComputeLineOfApprox;
0037 class BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox;
0038 class BRepApprox_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfApprox;
0039 class AppParCurves_MultiCurve;
0040
0041 class BRepApprox_MyGradientbisOfTheComputeLineOfApprox
0042 {
0043 public:
0044   DEFINE_STANDARD_ALLOC
0045
0046   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
0047   //! where Pui describe the approximating Bezier curves'Poles
0048   //! and Qi the MultiLine points with a parameter ui.
0049   //! In this algorithm, the parameters ui are the unknowns.
0050   //! The tolerance required on this sum is given by Tol.
0051   //! The desired degree of the resulting curve is Deg.
0052   Standard_EXPORT BRepApprox_MyGradientbisOfTheComputeLineOfApprox(
0053     const BRepApprox_TheMultiLineOfApprox&                                 SSP,
0054     const int                                                              FirstPoint,
0055     const int                                                              LastPoint,
0056     const occ::handle<NCollection_HArray1<AppParCurves_ConstraintCouple>>& TheConstraints,
0057     math_Vector&                                                           Parameters,
0058     const int                                                              Deg,
0059     const double                                                           Tol3d,
0060     const double                                                           Tol2d,
0061     const int                                                              NbIterations = 200);
0062
0063   //! returns True if all has been correctly done.
0064   Standard_EXPORT bool IsDone() const;
0065
0066   //! returns all the Bezier curves approximating the
0067   //! MultiLine SSP after minimization of the parameter.
0068   Standard_EXPORT AppParCurves_MultiCurve Value() const;
0069
0070   //! returns the difference between the old and the new
0071   //! approximation.
0072   //! An exception is raised if NotDone.
0073   //! An exception is raised if Index<1 or Index>NbParameters.
0074   Standard_EXPORT double Error(const int Index) const;
0075
0076   //! returns the maximum difference between the old and the
0077   //! new approximation.
0078   Standard_EXPORT double MaxError3d() const;
0079
0080   //! returns the maximum difference between the old and the
0081   //! new approximation.
0082   Standard_EXPORT double MaxError2d() const;
0083
0084   //! returns the average error between the old and the
0085   //! new approximation.
0086   Standard_EXPORT double AverageError() const;
0087
0088 private:
0089   AppParCurves_MultiCurve SCU;
0090   math_Vector             ParError;
0091   double                  AvError;
0092   double                  MError3d;
0093   double                  MError2d;
0094   bool                    Done;
0095 };
0096
0097 #endif // _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile