Documentation - Fix whitespace and typos (#772)

- Corrected spelling errors (e.g., "aera" → "area", "nithing" → "nothing")
- Normalized excessive whitespace in comments for better readability
- Standardized comment formatting while preserving technical content
This commit is contained in:
luzpaz
2025-10-29 13:57:19 -04:00
committed by GitHub
parent cd3fc87130
commit ae33c4ef42
59 changed files with 358 additions and 362 deletions
@@ -25,8 +25,8 @@
#include <TColStd_HArray1OfReal.hxx>
#include <TColStd_HArray2OfReal.hxx>
//! contains all the parameters for approximation
//! ( tolerancy, computing option, ...)
//! contains all the parameters for approximation
//! (tolerancy, computing option, ...)
class AdvApp2Var_Context
{
public:
@@ -3048,7 +3048,7 @@ int mmdrvcb_(integer* ideriv,
/* TABPNT : Table of values of consecutive derivatives */
/* of parameter TPARAM. */
/* IERCOD : 0 = OK, */
/* 1 = incoherent input. */
/* 1 = incoherent input. */
/* COMMONS USED : */
/* ---------------- */
@@ -3237,10 +3237,10 @@ int AdvApp2Var_MathBase::mmdrvck_(integer* ncoeff,
/* INPUT ARGUMENTS : */
/* ------------------ */
/* NCOEFF : Degree +1 of the curve. */
/* NDIMEN : Dimension of the space (2 or 3 in general) */
/* NDIMEN : Dimension of the space (2 or 3 in general) */
/* COURBE : Table of coefficients of the curve. */
/* IDERIV : Required order of derivation : 1=1st derivative, etc... */
/* TPARAM : Value of parameter of the curve. */
/* IDERIV : Required order of derivation : 1=1st derivative, etc... */
/* TPARAM : Value of parameter of the curve. */
/* OUTPUT ARGUMENTS : */
/* ------------------- */
@@ -4290,8 +4290,7 @@ int AdvApp2Var_MathBase::mmfmcb5_(integer* isenmsc,
/* -------------------- */
/* ISENMSC : required direction of the transfer : */
/* 1 : passage of (NDIMEN,.) ---> (.,NDIMEN) direction to AB */
/* -1 : passage of (.,NDIMEN) ---> (NDIMEN,.) direction to TS,T
V*/
/* -1 : passage of (.,NDIMEN) ---> (NDIMEN,.) direction to TS,T V*/
/* NDIMAX : format / dimension */
/* NCF1MX : format by t of COURB1 */
/* if ISENMSC= 1 : COURB1: The curve to be processed (NDIMAX,.) */
@@ -2284,7 +2284,7 @@ int AdvApp2Var_SysBase::mcrfill_(integer* size, void* tin, void* tout)
/* Routine mcrfree */
/* -------------- */
/* */
/* Desallocation of a memory zone . */
/* Desallocation of a memory zone. */
/* */
/* CALL MCRFREE (IBYTE,IADR,IER) */
/* */
@@ -153,7 +153,7 @@ public:
//! returns the result of the approximation.
Standard_EXPORT const AppParCurves_MultiBSpCurve& SplineValue();
//! returns the type of parametrization
//! returns the type of parametrization
Standard_EXPORT Approx_ParametrizationType Parametrization() const;
//! returns the new parameters of the approximation
@@ -59,7 +59,7 @@ public:
Standard_EXPORT AppDef_MultiLine();
//! given the number NbMult of MultiPointConstraints of this
//! MultiLine , it initializes all the fields.SetValue must be
//! MultiLine, it initializes all the fields.SetValue must be
//! called in order for the values of the multipoint
//! constraint to be taken into account.
//! An exception is raised if NbMult < 0.
@@ -37,7 +37,7 @@ class FEmTool_Assembly;
class PLib_Base;
//! This class is used to smooth N points with constraints
//! by minimization of quadratic criterium but also
//! by minimization of quadratic criterium but also
//! variational criterium in order to obtain " fair Curve "
//! Computes the approximation of a Multiline by
//! Variational optimization.
@@ -47,10 +47,10 @@ public:
DEFINE_STANDARD_ALLOC
//! Constructor.
//! Initialization of the fields.
//! Initialization of the fields.
//! warning : Nc0 : number of PassagePoint consraints
//! Nc2 : number of TangencyPoint constraints
//! Nc3 : number of CurvaturePoint constraints
//! Nc2 : number of TangencyPoint constraints
//! Nc3 : number of CurvaturePoint constraints
//! if
//! ((MaxDegree-Continuity)*MaxSegment -Nc0 - 2*Nc1
//! -3*Nc2)
@@ -76,11 +76,11 @@ public:
Standard_EXPORT void Approximate();
//! returns True if the creation is done
//! and correspond to the current fields.
//! and correspond to the current fields.
Standard_EXPORT Standard_Boolean IsCreated() const;
//! returns True if the approximation is ok
//! and correspond to the current fields.
//! and correspond to the current fields.
Standard_EXPORT Standard_Boolean IsDone() const;
//! returns True if the problem is overconstrained
@@ -123,8 +123,8 @@ public:
Standard_Real& VSecondOrder,
Standard_Real& VThirdOrder) const;
//! returns the Weights (as percent) associed to the criterium used in
//! the optimization.
//! returns the Weights (as percent) associed to the criterium used in
//! the optimization.
Standard_EXPORT void CriteriumWeight(Standard_Real& Percent1,
Standard_Real& Percent2,
Standard_Real& Percent3) const;
@@ -138,11 +138,11 @@ public:
//! returns the Continuity used in the approximation
Standard_EXPORT GeomAbs_Shape Continuity() const;
//! returns if the approximation search to minimize the
//! returns if the approximation search to minimize the
//! maximum Error or not.
Standard_EXPORT Standard_Boolean WithMinMax() const;
//! returns if the approximation can insert new Knots or not.
//! returns if the approximation can insert new Knots or not.
Standard_EXPORT Standard_Boolean WithCutting() const;
//! returns the tolerance used in the approximation.
@@ -186,11 +186,11 @@ public:
//! this method modify nothing and returns false
Standard_EXPORT Standard_Boolean SetContinuity(const GeomAbs_Shape C);
//! Define if the approximation search to minimize the
//! Define if the approximation search to minimize the
//! maximum Error or not.
Standard_EXPORT void SetWithMinMax(const Standard_Boolean MinMax);
//! Define if the approximation can insert new Knots or not.
//! Define if the approximation can insert new Knots or not.
//! If this value is incompatible with the others fields
//! this method modify nothing and returns false
Standard_EXPORT Standard_Boolean SetWithCutting(const Standard_Boolean Cutting);
@@ -203,8 +203,8 @@ public:
const Standard_Real Percent2,
const Standard_Real Percent3);
//! define the Weight (as percent) associed to the
//! criterium Order used in the optimization : Others
//! define the Weight (as percent) associed to the
//! criterium Order used in the optimization : Others
//! weights are updated.
//! if Percent < 0
//! if Order < 1 or Order > 3
@@ -41,7 +41,7 @@ public:
Standard_EXPORT Standard_Boolean IsDone() const;
//! returns Standard_True if the approximation did come out
//! with a result that is not NECESSARELY within the required
//! with a result that is not NECESSARILY within the required
//! tolerance
Standard_EXPORT Standard_Boolean HasResult() const;
@@ -24,7 +24,7 @@
class Geom_BSplineCurve;
class Geom2d_BSplineCurve;
//! Approximation of curve on surface
//! Approximation of curve on surface
class Approx_CurveOnSurface
{
public:
@@ -24,7 +24,7 @@ class Geom_Curve;
class Geom2d_Curve;
class Geom_Surface;
//! Approximation of a PCurve on a surface to make its
//! Approximation of a PCurve on a surface to make its
//! parameter be the same that the parameter of a given 3d
//! reference curve.
class Approx_SameParameter
@@ -48,8 +48,8 @@ public:
TColgp_Array1OfPnt2d& Poles2d,
TColStd_Array1OfReal& Weigths) = 0;
//! compute the first derivative in v direction of the
//! section for v = param
//! compute the first derivative in v direction of the
//! section for v = param
//! Warning : It used only for C1 or C2 approximation
Standard_EXPORT virtual Standard_Boolean D1(const Standard_Real Param,
const Standard_Real First,
@@ -61,8 +61,8 @@ public:
TColStd_Array1OfReal& Weigths,
TColStd_Array1OfReal& DWeigths);
//! compute the second derivative in v direction of the
//! section for v = param
//! compute the second derivative in v direction of the
//! section for v = param
//! Warning : It used only for C2 approximation
Standard_EXPORT virtual Standard_Boolean D2(const Standard_Real Param,
const Standard_Real First,
@@ -77,10 +77,10 @@ public:
TColStd_Array1OfReal& DWeigths,
TColStd_Array1OfReal& D2Weigths);
//! get the number of 2d curves to approximate.
//! get the number of 2d curves to approximate.
Standard_EXPORT virtual Standard_Integer Nb2dCurves() const = 0;
//! get the format of an section
//! get the format of an section
Standard_EXPORT virtual void SectionShape(Standard_Integer& NbPoles,
Standard_Integer& NbKnots,
Standard_Integer& Degree) const = 0;
@@ -94,20 +94,20 @@ public:
//! Returns if the sections are rational or not
Standard_EXPORT virtual Standard_Boolean IsRational() const = 0;
//! Returns the number of intervals for continuity
//! Returns the number of intervals for continuity
//! <S>.
//! May be one if Continuity(me) >= <S>
Standard_EXPORT virtual Standard_Integer NbIntervals(const GeomAbs_Shape S) const = 0;
//! Stores in <T> the parameters bounding the intervals
//! Stores in <T> the parameters bounding the intervals
//! of continuity <S>.
//!
//! The array must provide enough room to accommodate
//! The array must provide enough room to accommodate
//! for the parameters. i.e. T.Length() > NbIntervals()
Standard_EXPORT virtual void Intervals(TColStd_Array1OfReal& T, const GeomAbs_Shape S) const = 0;
//! Sets the bounds of the parametric interval on
//! the fonction
//! the function
//! This determines the derivatives in these values if the
//! function is not Cn.
Standard_EXPORT virtual void SetInterval(const Standard_Real First, const Standard_Real Last) = 0;
@@ -33,7 +33,7 @@ public:
CPnts_MyGaussFunction();
//! F is a pointer on a function D is a client data
//! F is a pointer on a function D is a client data
//!
//! Each value is computed with F(D)
Standard_EXPORT void Init(const CPnts_RealFunction& F, const Standard_Address D);
@@ -36,7 +36,7 @@ public:
CPnts_MyRootFunction();
//! F is a pointer on a function D is a client data
//! F is a pointer on a function D is a client data
//! Order is the order of integration to use
Standard_EXPORT void Init(const CPnts_RealFunction& F,
const Standard_Address D,
@@ -102,12 +102,12 @@ public:
//! order of derivation N.
static gp_Vec2d DN(const Adaptor2d_Curve2d& C, const Standard_Real U, const Standard_Integer N);
//! Returns the parametric resolution corresponding
//! Returns the parametric resolution corresponding
//! to the real space resolution <R3d>.
static Standard_Real Resolution(const Adaptor2d_Curve2d& C, const Standard_Real R3d);
//! Returns the type of the curve in the current
//! interval : Line, Circle, Ellipse, Hyperbola,
//! Returns the type of the curve in the current
//! interval : Line, Circle, Ellipse, Hyperbola,
//! Parabola, BezierCurve, BSplineCurve, OtherCurve.
static GeomAbs_CurveType GetType(const Adaptor2d_Curve2d& C);
@@ -46,7 +46,7 @@ public:
Standard_EXPORT Extrema_ECC2d(const Adaptor2d_Curve2d& C1, const Adaptor2d_Curve2d& C2);
//! Calculates all the distances as above
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! between Uinf and Usup for C1 and between Vinf and Vsup
//! for C2.
Standard_EXPORT Extrema_ECC2d(const Adaptor2d_Curve2d& C1,
const Adaptor2d_Curve2d& C2,
@@ -25,8 +25,8 @@
#include <Adaptor3d_Curve.hxx>
#include <Adaptor2d_Curve2d.hxx>
//! Computes a set of points on a curve from package
//! Adaptor3d such as between two successive points
//! Computes a set of points on a curve from package
//! Adaptor3d such as between two successive points
//! P1(u1)and P2(u2) :
//! @code
//! . ||P1P3^P3P2||/||P1P3||*||P3P2||<AngularDeflection
@@ -231,15 +231,15 @@ public:
const Standard_Real ClosedTolerance,
const Standard_Real AngularTolerance);
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! It returns a new BSpline which could still be C0.
//! tolerance is a geometrical tolerance
Standard_EXPORT static void C0BSplineToC1BSplineCurve(Handle(Geom2d_BSplineCurve)& BS,
const Standard_Real Tolerance);
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! It returns an array of BSpline C1.
//! Tolerance is a geometrical tolerance
Standard_EXPORT static void C0BSplineToArrayOfC1BSplineCurve(
@@ -247,8 +247,8 @@ public:
Handle(TColGeom2d_HArray1OfBSplineCurve)& tabBS,
const Standard_Real Tolerance);
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! It returns an array of BSpline C1.
//! tolerance is a geometrical tolerance
Standard_EXPORT static void C0BSplineToArrayOfC1BSplineCurve(
@@ -278,15 +278,15 @@ public:
//! or a trimmed sphere or a trimmed torus or a sphere or a torus or
//! a Bezier surface of a trimmed Bezier surface or a trimmed swept
//! surface with a corresponding basis curve which can be turned into
//! a B-spline curve (see the method CurveToBSplineCurve).
//! a B-spline curve (see the method CurveToBSplineCurve).
//! Raises DomainError if the type of the surface is not previously defined.
Standard_EXPORT static Handle(Geom_BSplineSurface) SurfaceToBSplineSurface(
const Handle(Geom_Surface)& S);
//! This Method concatenates G1 the ArrayOfCurves as far
//! as it is possible.
//! as it is possible.
//! ArrayOfCurves[0..N-1]
//! ArrayOfToler contains the biggest tolerance of the two
//! ArrayOfToler contains the biggest tolerance of the two
//! points shared by two consecutives curves.
//! Its dimension: [0..N-2]
//! ClosedFlag indicates if the ArrayOfCurves is closed.
@@ -340,31 +340,31 @@ public:
const Standard_Real ClosedTolerance,
const Standard_Real AngularTolerance);
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the
//! geometry). It returns a new BSpline which could still be C0.
//! tolerance is a geometrical tolerance.
//! The Angular toleranceis in radians and measures the angle of
//! the tangents on the left and on the right to decide if the
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the
//! geometry). It returns a new BSpline which could still be C0.
//! tolerance is a geometrical tolerance.
//! The Angular toleranceis in radians and measures the angle of
//! the tangents on the left and on the right to decide if the
//! curve is G1 or not at a given point
Standard_EXPORT static void C0BSplineToC1BSplineCurve(
Handle(Geom_BSplineCurve)& BS,
const Standard_Real tolerance,
const Standard_Real AngularTolerance = 1.0e-7);
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the geometry).
//! It returns an array of BSpline C1. tolerance is a geometrical tolerance.
Standard_EXPORT static void C0BSplineToArrayOfC1BSplineCurve(
const Handle(Geom_BSplineCurve)& BS,
Handle(TColGeom_HArray1OfBSplineCurve)& tabBS,
const Standard_Real tolerance);
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the
//! geometry). It returns an array of BSpline C1. tolerance is a
//! geometrical tolerance : it allows for the maximum deformation
//! The Angular tolerance is in radians and measures the angle of
//! This Method reduces as far as it is possible the
//! multiplicities of the knots of the BSpline BS.(keeping the
//! geometry). It returns an array of BSpline C1. tolerance is a
//! geometrical tolerance : it allows for the maximum deformation
//! The Angular tolerance is in radians and measures the angle of
//! the tangents on the left and on the right to decide if the curve
//! is C1 or not at a given point
Standard_EXPORT static void C0BSplineToArrayOfC1BSplineCurve(
+11 -11
View File
@@ -168,22 +168,22 @@ public:
//! result can happen if this is not satisfied. It is the caller
//! responsibility to check for that property.
//!
//! This method makes uniform NumPoints segments S1,...SNumPoints out
//! This method makes uniform NumPoints segments S1,...SNumPoints out
//! of the segment defined by the first parameter and the
//! last parameter of the InParameter ; keeps only one
//! last parameter of the InParameter ; keeps only one
//! point of the InParameters set of parameter in each of
//! the uniform segments taking care of the first and the
//! last parameters. For the ith segment the element of
//! last parameters. For the ith segment the element of
//! the InParameter is the one that is the first to exceed
//! the midpoint of the segment and to fall before the
//! midpoint of the next segment
//! There will be at the end at most NumPoints + 1 if
//! NumPoints > 2 in the OutParameters Array
//! There will be at the end at most NumPoints + 1
//! if NumPoints > 2 in the OutParameters Array
Standard_EXPORT static void RemovePointsFromArray(const Standard_Integer NumPoints,
const TColStd_Array1OfReal& InParameters,
Handle(TColStd_HArray1OfReal)& OutParameters);
//! this makes sure that there is at least MinNumPoints
//! this makes sure that there is at least MinNumPoints
//! in OutParameters taking into account the parameters in
//! the InParameters array provided those are in order,
//! that is the sequence of real in the InParameter is strictly
@@ -207,9 +207,9 @@ public:
const Standard_Real Confusion = 1.0e-9,
const Standard_Boolean IsAdjustToFirstInterval = Standard_False);
//! this will compute the maximum distance at the
//! parameters given in the Parameters array by
//! evaluating each parameter the two curves and taking
//! this will compute the maximum distance at the
//! parameters given in the Parameters array by
//! evaluating each parameter the two curves and taking
//! the maximum of the evaluated distance
Standard_EXPORT static void EvalMaxParametricDistance(const Adaptor3d_Curve& Curve,
const Adaptor3d_Curve& AReferenceCurve,
@@ -227,8 +227,8 @@ public:
const TColStd_Array1OfReal& Parameters,
Standard_Real& MaxDistance);
//! Cancel,on the boundaries,the denominator first derivative
//! in the directions wished by the user and set its value to 1.
//! Cancel,on the boundaries,the denominator first derivative
//! in the directions wished by the user and set its value to 1.
Standard_EXPORT static void CancelDenominatorDerivative(Handle(Geom_BSplineSurface)& BSurf,
const Standard_Boolean UDirection,
const Standard_Boolean VDirection);
@@ -23,7 +23,7 @@
class Geom2d_BSplineCurve;
//! Checks for the end tangents : whether or not those
//! Checks for the end tangents : whether or not those
//! are reversed
class GeomLib_Check2dBSplineCurve
{
@@ -24,7 +24,7 @@
#include <math_Vector.hxx>
#include <math_FunctionWithDerivative.hxx>
//! Polynomial Function
//! Polynomial Function
class GeomLib_PolyFunc : public math_FunctionWithDerivative
{
public:
@@ -24,9 +24,9 @@
class Geom2d_BSplineCurve;
class Geom_BSplineCurve;
//! This is used to reparameterize Rational BSpline
//! Curves so that we can concatenate them later to
//! build C1 Curves It builds and 1D-reparameterizing
//! This is used to reparameterize Rational BSpline
//! Curves so that we can concatenate them later to
//! build C1 Curves It builds and 1D-reparameterizing
//! function starting from an Hermite interpolation and
//! adding knots and modifying poles of the 1D BSpline
//! obtained that way. The goal is to build a(u) so that
@@ -44,7 +44,7 @@ public:
//! Empty Constructor
Standard_EXPORT IntAna_IntQuadQuad();
//! Creates the intersection between a cylinder and a quadric .
//! Creates the intersection between a cylinder and a quadric.
//! Tol est a definir plus precisemment.
Standard_EXPORT IntAna_IntQuadQuad(const gp_Cylinder& C,
const IntAna_Quadric& Q,
@@ -92,17 +92,17 @@ public:
Standard_Real& U1,
Standard_Real& U2) const;
//! Returns True if the Curve I shares its last bound
//! Returns True if the Curve I shares its last bound
//! with another curve.
Standard_EXPORT Standard_Boolean HasNextCurve(const Standard_Integer I) const;
//! If HasNextCurve(I) returns True, this function
//! returns the Index J of the curve which has a
//! common bound with the curve I. If theOpposite ==
//! True , then the last parameter of the curve I, and
//! the last parameter of the curve J give the same
//! point. Else the last parameter of the curve I and
//! the first parameter of the curve J are the same
//! If HasNextCurve(I) returns True, this function
//! returns the Index J of the curve which has a
//! common bound with the curve I. If theOpposite ==
//! True, then the last parameter of the curve I, and
//! the last parameter of the curve J give the same
//! point. Else the last parameter of the curve I and
//! the first parameter of the curve J are the same
//! point.
Standard_EXPORT Standard_Integer NextCurve(const Standard_Integer I,
Standard_Boolean& theOpposite) const;
@@ -112,13 +112,13 @@ public:
Standard_EXPORT Standard_Boolean HasPreviousCurve(const Standard_Integer I) const;
//! if HasPreviousCurve(I) returns True, this function
//! returns the Index J of the curve which has a
//! common bound with the curve I. If theOpposite ==
//! True , then the first parameter of the curve I,
//! and the first parameter of the curve J give the
//! same point. Else the first parameter of the curve
//! I and the last parameter of the curve J are the
//! same point.
//! returns the Index J of the curve which has a common
//! bound with the curve I. If theOpposite == True
//! then the first parameter of the curve I, and the
//! first parameter of the curve J give the same
//! point. Else the first parameter of the curve I and
//! the last parameter of the curve J are the same
//! point.
Standard_EXPORT Standard_Integer PreviousCurve(const Standard_Integer I,
Standard_Boolean& theOpposite) const;
@@ -120,8 +120,8 @@ public:
Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
//! If necessary, breaks the curve in intervals of
//! continuity <S>. And returns the number of
//! If necessary, breaks the curve in intervals of
//! continuity <S>. And returns the number of
//! intervals.
Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
@@ -186,7 +186,7 @@ public:
Standard_EXPORT gp_Vec2d DN(const Standard_Real U,
const Standard_Integer N) const Standard_OVERRIDE;
//! Returns the parametric resolution corresponding
//! Returns the parametric resolution corresponding
//! to the real space resolution <R3d>.
Standard_EXPORT Standard_Real Resolution(const Standard_Real R3d) const Standard_OVERRIDE;
@@ -97,7 +97,7 @@ public:
//! Make a pln passing through the location of <Axis>and
//! normal to the Direction of <Axis>.
//! Warning - If an error occurs (that is, when IsDone returns
//! Warning - If an error occurs (that is, when IsDone returns
//! false), the Status function returns:
//! - gce_BadEquation if Sqrt(A*A + B*B +
//! C*C) is less than or equal to gp::Resolution(),