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_HArray1OfConstraintCouple.hxx>
0029 class Standard_OutOfRange;
0030 class StdFail_NotDone;
0031 class BRepApprox_TheMultiLineOfApprox;
0032 class BRepApprox_TheMultiLineToolOfApprox;
0033 class BRepApprox_ParLeastSquareOfMyGradientbisOfTheComputeLineOfApprox;
0034 class BRepApprox_ResConstraintOfMyGradientbisOfTheComputeLineOfApprox;
0035 class BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox;
0036 class BRepApprox_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfApprox;
0037 class AppParCurves_MultiCurve;
0038
0039 class BRepApprox_MyGradientbisOfTheComputeLineOfApprox
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
0045   //! where Pui describe the approximating Bezier curves'Poles
0046   //! and Qi the MultiLine points with a parameter ui.
0047   //! In this algorithm, the parameters ui are the unknowns.
0048   //! The tolerance required on this sum is given by Tol.
0049   //! The desired degree of the resulting curve is Deg.
0050   Standard_EXPORT BRepApprox_MyGradientbisOfTheComputeLineOfApprox(
0051     const BRepApprox_TheMultiLineOfApprox&                SSP,
0052     const Standard_Integer                                FirstPoint,
0053     const Standard_Integer                                LastPoint,
0054     const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints,
0055     math_Vector&                                          Parameters,
0056     const Standard_Integer                                Deg,
0057     const Standard_Real                                   Tol3d,
0058     const Standard_Real                                   Tol2d,
0059     const Standard_Integer                                NbIterations = 200);
0060
0061   //! returns True if all has been correctly done.
0062   Standard_EXPORT Standard_Boolean IsDone() const;
0063
0064   //! returns all the Bezier curves approximating the
0065   //! MultiLine SSP after minimization of the parameter.
0066   Standard_EXPORT AppParCurves_MultiCurve Value() const;
0067
0068   //! returns the difference between the old and the new
0069   //! approximation.
0070   //! An exception is raised if NotDone.
0071   //! An exception is raised if Index<1 or Index>NbParameters.
0072   Standard_EXPORT Standard_Real Error(const Standard_Integer Index) const;
0073
0074   //! returns the maximum difference between the old and the
0075   //! new approximation.
0076   Standard_EXPORT Standard_Real MaxError3d() const;
0077
0078   //! returns the maximum difference between the old and the
0079   //! new approximation.
0080   Standard_EXPORT Standard_Real MaxError2d() const;
0081
0082   //! returns the average error between the old and the
0083   //! new approximation.
0084   Standard_EXPORT Standard_Real AverageError() const;
0085
0086 protected:
0087 private:
0088   AppParCurves_MultiCurve SCU;
0089   math_Vector             ParError;
0090   Standard_Real           AvError;
0091   Standard_Real           MError3d;
0092   Standard_Real           MError2d;
0093   Standard_Boolean        Done;
0094 };
0095
0096 #endif // _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile