include/opencascade/AppDef_MyBSplGradientOfBSplineCompute.hxx

0001 // Created on: 1991-12-02
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1991-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 _AppDef_MyBSplGradientOfBSplineCompute_HeaderFile
0018 #define _AppDef_MyBSplGradientOfBSplineCompute_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <AppParCurves_MultiBSpCurve.hxx>
0025 #include <math_Vector.hxx>
0026 #include <Standard_Real.hxx>
0027 #include <Standard_Integer.hxx>
0028 #include <AppParCurves_HArray1OfConstraintCouple.hxx>
0029 #include <TColStd_Array1OfReal.hxx>
0030 #include <TColStd_Array1OfInteger.hxx>
0031 class Standard_OutOfRange;
0032 class StdFail_NotDone;
0033 class AppDef_MultiLine;
0034 class AppDef_MyLineTool;
0035 class AppDef_BSpParLeastSquareOfMyBSplGradientOfBSplineCompute;
0036 class AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute;
0037 class AppDef_BSpGradient_BFGSOfMyBSplGradientOfBSplineCompute;
0038 class AppParCurves_MultiBSpCurve;
0039
0040
0041
0042 class AppDef_MyBSplGradientOfBSplineCompute
0043 {
0044 public:
0045
0046   DEFINE_STANDARD_ALLOC
0047
0048
0049   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
0050   //! where Pui describe the approximating BSpline curves'Poles
0051   //! and Qi the MultiLine points with a parameter ui.
0052   //! In this algorithm, the parameters ui are the unknowns.
0053   //! The tolerance required on this sum is given by Tol.
0054   //! The desired degree of the resulting curve is Deg.
0055   Standard_EXPORT AppDef_MyBSplGradientOfBSplineCompute(const AppDef_MultiLine& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, math_Vector& Parameters, const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, const Standard_Integer Deg, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer NbIterations = 1);
0056
0057   //! Tries to minimize the sum (square(||Qui - Bi*Pi||))
0058   //! where Pui describe the approximating BSpline curves'Poles
0059   //! and Qi the MultiLine points with a parameter ui.
0060   //! In this algorithm, the parameters ui are the unknowns.
0061   //! The tolerance required on this sum is given by Tol.
0062   //! The desired degree of the resulting curve is Deg.
0063   Standard_EXPORT AppDef_MyBSplGradientOfBSplineCompute(const AppDef_MultiLine& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, math_Vector& Parameters, const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, const Standard_Integer Deg, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer NbIterations, const Standard_Real lambda1, const Standard_Real lambda2);
0064
0065   //! returns True if all has been correctly done.
0066   Standard_EXPORT Standard_Boolean IsDone() const;
0067
0068   //! returns all the BSpline curves approximating the
0069   //! MultiLine SSP after minimization of the parameter.
0070   Standard_EXPORT AppParCurves_MultiBSpCurve Value() const;
0071
0072   //! returns the difference between the old and the new
0073   //! approximation.
0074   //! An exception is raised if NotDone.
0075   //! An exception is raised if Index<1 or Index>NbParameters.
0076   Standard_EXPORT Standard_Real Error (const Standard_Integer Index) const;
0077
0078   //! returns the maximum difference between the old and the
0079   //! new approximation.
0080   Standard_EXPORT Standard_Real MaxError3d() const;
0081
0082   //! returns the maximum difference between the old and the
0083   //! new approximation.
0084   Standard_EXPORT Standard_Real MaxError2d() const;
0085
0086   //! returns the average error between the old and the
0087   //! new approximation.
0088   Standard_EXPORT Standard_Real AverageError() const;
0089
0090
0091
0092
0093 protected:
0094
0095
0096   Standard_EXPORT void Perform (const AppDef_MultiLine& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, math_Vector& Parameters, const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, const Standard_Integer Deg, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer NbIterations = 200);
0097
0098
0099
0100
0101 private:
0102
0103
0104
0105   AppParCurves_MultiBSpCurve SCU;
0106   math_Vector ParError;
0107   Standard_Real AvError;
0108   Standard_Real MError3d;
0109   Standard_Real MError2d;
0110   Standard_Real mylambda1;
0111   Standard_Real mylambda2;
0112   Standard_Boolean myIsLambdaDefined;
0113   Standard_Boolean Done;
0114
0115
0116 };
0117
0118
0119
0120
0121
0122
0123
0124 #endif // _AppDef_MyBSplGradientOfBSplineCompute_HeaderFile