1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-10 18:51:21 +03:00
occt/src/BRepApprox/BRepApprox_MyGradientbisOfTheComputeLineOfApprox.hxx
rkv 36b9ff756a 0026595: Lost some comments in OCCT-code after cdl elimination
Recovered comments for instance classes from CDL generic classes.
2015-10-15 14:04:43 +03:00

112 lines
3.6 KiB
C++

// Created on: 1995-06-06
// Created by: Jean Yves LEBEY
// 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.
#ifndef _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile
#define _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <AppParCurves_MultiCurve.hxx>
#include <math_Vector.hxx>
#include <Standard_Real.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Integer.hxx>
#include <AppParCurves_HArray1OfConstraintCouple.hxx>
class Standard_OutOfRange;
class StdFail_NotDone;
class BRepApprox_TheMultiLineOfApprox;
class BRepApprox_TheMultiLineToolOfApprox;
class BRepApprox_ParLeastSquareOfMyGradientbisOfTheComputeLineOfApprox;
class BRepApprox_ResConstraintOfMyGradientbisOfTheComputeLineOfApprox;
class BRepApprox_ParFunctionOfMyGradientbisOfTheComputeLineOfApprox;
class BRepApprox_Gradient_BFGSOfMyGradientbisOfTheComputeLineOfApprox;
class AppParCurves_MultiCurve;
class BRepApprox_MyGradientbisOfTheComputeLineOfApprox
{
public:
DEFINE_STANDARD_ALLOC
//! Tries to minimize the sum (square(||Qui - Bi*Pi||))
//! where Pui describe the approximating Bezier curves'Poles
//! and Qi the MultiLine points with a parameter ui.
//! In this algorithm, the parameters ui are the unknowns.
//! The tolerance required on this sum is given by Tol.
//! The desired degree of the resulting curve is Deg.
Standard_EXPORT BRepApprox_MyGradientbisOfTheComputeLineOfApprox(const BRepApprox_TheMultiLineOfApprox& 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);
//! returns True if all has been correctly done.
Standard_EXPORT Standard_Boolean IsDone() const;
//! returns all the Bezier curves approximating the
//! MultiLine SSP after minimization of the parameter.
Standard_EXPORT AppParCurves_MultiCurve Value() const;
//! returns the difference between the old and the new
//! approximation.
//! An exception is raised if NotDone.
//! An exception is raised if Index<1 or Index>NbParameters.
Standard_EXPORT Standard_Real Error (const Standard_Integer Index) const;
//! returns the maximum difference between the old and the
//! new approximation.
Standard_EXPORT Standard_Real MaxError3d() const;
//! returns the maximum difference between the old and the
//! new approximation.
Standard_EXPORT Standard_Real MaxError2d() const;
//! returns the average error between the old and the
//! new approximation.
Standard_EXPORT Standard_Real AverageError() const;
protected:
private:
AppParCurves_MultiCurve SCU;
math_Vector ParError;
Standard_Real AvError;
Standard_Real MError3d;
Standard_Real MError2d;
Standard_Boolean Done;
};
#endif // _BRepApprox_MyGradientbisOfTheComputeLineOfApprox_HeaderFile