0026595: Lost some comments in OCCT-code after cdl elimination

[occt.git] / src / BRepApprox / BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox.hxx

diff --git a/src/BRepApprox/BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox.hxx b/src/BRepApprox/BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox.hxx
index 35f64c2..e4ac5c7 100644 (file)
--- a/src/BRepApprox/BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox.hxx
+++ b/src/BRepApprox/BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox.hxx
@@ -51,30 +51,59 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! initializes the fields of the function. The approximating
+  //! curve has <NbPol> control points.
   Standard_EXPORT BRepApprox_BSpParFunctionOfMyBSplGradientOfTheComputeLineOfApprox(const BRepApprox_TheMultiLineOfApprox& SSP, const Standard_Integer FirstPoint, const Standard_Integer LastPoint, const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, const math_Vector& Parameters, const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, const Standard_Integer NbPol);
   
+  //! returns the number of variables of the function. It
+  //! corresponds to the number of MultiPoints.
   Standard_EXPORT Standard_Integer NbVariables() const;
   
+  //! this method computes the new approximation of the
+  //! MultiLine
+  //! SSP and calculates F = sum (||Pui - Bi*Pi||2) for each
+  //! point of the MultiLine.
   Standard_EXPORT Standard_Boolean Value (const math_Vector& X, Standard_Real& F);
   
+  //! returns the gradient G of the sum above for the
+  //! parameters Xi.
   Standard_EXPORT Standard_Boolean Gradient (const math_Vector& X, math_Vector& G);
   
+  //! returns the value F=sum(||Pui - Bi*Pi||)2.
+  //! returns the value G = grad(F) for the parameters Xi.
   Standard_EXPORT Standard_Boolean Values (const math_Vector& X, Standard_Real& F, math_Vector& G);
   
+  //! returns the new parameters of the MultiLine.
   Standard_EXPORT const math_Vector& NewParameters() const;
   
+  //! returns the MultiBSpCurve approximating the set after
+  //! computing the value F or Grad(F).
   Standard_EXPORT AppParCurves_MultiBSpCurve CurveValue();
   
+  //! returns the distance between the MultiPoint of range
+  //! IPoint and the curve CurveIndex.
   Standard_EXPORT Standard_Real Error (const Standard_Integer IPoint, const Standard_Integer CurveIndex);
   
+  //! returns the maximum distance between the points
+  //! and the MultiBSpCurve.
   Standard_EXPORT Standard_Real MaxError3d() const;
   
+  //! returns the maximum distance between the points
+  //! and the MultiBSpCurve.
   Standard_EXPORT Standard_Real MaxError2d() const;
   
+  //! returns the function matrix used to approximate the
+  //! multiline.
   Standard_EXPORT const math_Matrix& FunctionMatrix() const;
   
+  //! returns the derivative function matrix used to approximate the
+  //! multiline.
   Standard_EXPORT const math_Matrix& DerivativeFunctionMatrix() const;
   
+  //! Returns the indexes of the first non null values of
+  //! A and DA.
+  //! The values are non null from Index(ieme point) +1
+  //! to Index(ieme point) + degree +1.
   Standard_EXPORT const math_IntegerVector& Index() const;
   
   Standard_EXPORT AppParCurves_Constraint FirstConstraint (const Handle(AppParCurves_HArray1OfConstraintCouple)& TheConstraints, const Standard_Integer FirstPoint) const;
@@ -91,6 +120,8 @@ public:
 protected:
 
   
+  //! this method is used each time Value or Gradient is
+  //! needed.
   Standard_EXPORT void Perform (const math_Vector& X);