diff --git a/samples/mfc/standard/Common/OCC_2dView.cpp b/samples/mfc/standard/Common/OCC_2dView.cpp index 05da018848..f127c5b510 100755 --- a/samples/mfc/standard/Common/OCC_2dView.cpp +++ b/samples/mfc/standard/Common/OCC_2dView.cpp @@ -217,7 +217,7 @@ void OCC_2dView::OnUpdateBUTTONGridCancel(CCmdUI* pCmdUI) void OCC_2dView::OnSize(UINT nType, int cx, int cy) { OCC_BaseView::OnSize (nType, cx, cy); - // Take care : This fonction is call before OnInitialUpdate + // Take care : This function is called before OnInitialUpdate if (!myView.IsNull()) myView->MustBeResized(); } diff --git a/src/IGESControl/IGESControl_IGESBoundary.cxx b/src/IGESControl/IGESControl_IGESBoundary.cxx index 12106ba106..3169a9a38a 100644 --- a/src/IGESControl/IGESControl_IGESBoundary.cxx +++ b/src/IGESControl/IGESControl_IGESBoundary.cxx @@ -193,7 +193,7 @@ static Standard_Boolean Connect (const Handle(ShapeAnalysis_Wire)& theSAW, GTranslate2d = Standard_False; if (GTranslate3d && GTranslate2d) { - //Setting preference in the case of inconsitency between 3D and 2D + //Setting preference in the case of inconsistency between 3D and 2D if (surfcurv == 2) Preferred3d = Standard_False; else if (surfcurv == 3) Preferred2d = Standard_False; else if (myfilepreference == 2) Preferred3d = Standard_False; diff --git a/src/IGESGeom/IGESGeom_ConicArc.hxx b/src/IGESGeom/IGESGeom_ConicArc.hxx index bb276f7da6..df39068343 100644 --- a/src/IGESGeom/IGESGeom_ConicArc.hxx +++ b/src/IGESGeom/IGESGeom_ConicArc.hxx @@ -108,7 +108,7 @@ public: Standard_EXPORT gp_Dir TransformedAxis() const; //! Returns a Definition computed from equation, easier to use - //!
: the center of the the conic (meaningless for + //!
: the center of the conic (meaningless for //! a parabola) (defined with Z displacement) //! : the Main Axis of the conic (for a Circle, //! arbitrary the X Axis) diff --git a/src/IGESSelect/IGESSelect_FloatFormat.hxx b/src/IGESSelect/IGESSelect_FloatFormat.hxx index 40e5d901f4..ba702ab101 100644 --- a/src/IGESSelect/IGESSelect_FloatFormat.hxx +++ b/src/IGESSelect/IGESSelect_FloatFormat.hxx @@ -59,7 +59,7 @@ public: //! Sets Main Format to a new value //! Remark : SetFormat, SetZeroSuppress and SetFormatForRange are - //! independant + //! independent Standard_EXPORT void SetFormat (const Standard_CString format = "%E"); //! Sets Format for Range to a new value with its range of diff --git a/src/IGESSelect/IGESSelect_SelectPCurves.hxx b/src/IGESSelect/IGESSelect_SelectPCurves.hxx index b3967503ce..c388d93be9 100644 --- a/src/IGESSelect/IGESSelect_SelectPCurves.hxx +++ b/src/IGESSelect/IGESSelect_SelectPCurves.hxx @@ -48,7 +48,7 @@ public: Standard_EXPORT IGESSelect_SelectPCurves(const Standard_Boolean basic); //! Explores an entity, to take its contained PCurves - //! An independant curve is IGNORED : only faces are explored + //! An independent curve is IGNORED : only faces are explored Standard_EXPORT Standard_Boolean Explore (const Standard_Integer level, const Handle(Standard_Transient)& ent, const Interface_Graph& G, Interface_EntityIterator& explored) const Standard_OVERRIDE; //! Returns a text defining the criterium : "Basic PCurves" or diff --git a/src/IGESSelect/IGESSelect_SelectSubordinate.hxx b/src/IGESSelect/IGESSelect_SelectSubordinate.hxx index f8502d1806..4215a2f83b 100644 --- a/src/IGESSelect/IGESSelect_SelectSubordinate.hxx +++ b/src/IGESSelect/IGESSelect_SelectSubordinate.hxx @@ -37,14 +37,14 @@ DEFINE_STANDARD_HANDLE(IGESSelect_SelectSubordinate, IFSelect_SelectExtract) //! This selections uses Subordinate Status as sort criterium //! It is an integer number which can be : -//! 0 Independant -//! 1 Physically Dependant -//! 2 Logically Dependant +//! 0 Independent +//! 1 Physically Dependent +//! 2 Logically Dependent //! 3 Both (recorded) //! + to sort : //! 4 : 1 or 3 -> at least Physically //! 5 : 2 or 3 -> at least Logically -//! 6 : 1 or 2 or 3 -> any kind of dependance +//! 6 : 1 or 2 or 3 -> any kind of dependence //! (corresponds to 0 reversed) class IGESSelect_SelectSubordinate : public IFSelect_SelectExtract { @@ -62,7 +62,7 @@ public: //! Status matching the criterium Standard_EXPORT Standard_Boolean Sort (const Standard_Integer rank, const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE; - //! Returns the Selection criterium : "IGES Entity, Independant" + //! Returns the Selection criterium : "IGES Entity, Independent" //! etc... Standard_EXPORT TCollection_AsciiString ExtractLabel() const Standard_OVERRIDE; diff --git a/src/IGESToBRep/IGESToBRep_IGESBoundary.cxx b/src/IGESToBRep/IGESToBRep_IGESBoundary.cxx index 0afd25a328..21e04d07e4 100644 --- a/src/IGESToBRep/IGESToBRep_IGESBoundary.cxx +++ b/src/IGESToBRep/IGESToBRep_IGESBoundary.cxx @@ -172,7 +172,7 @@ IGESToBRep_IGESBoundary::IGESToBRep_IGESBoundary(const IGESToBRep_CurveAndSurfac GTranslate2d = Standard_False; if (GTranslate3d && GTranslate2d) { - //Setting preference in the case of inconsitency between 3D and 2D + //Setting preference in the case of inconsistency between 3D and 2D if (myfilepreference == 2) Preferred3d = Standard_False; else if (myfilepreference == 3) Preferred2d = Standard_False; else Preferred3d = Standard_False; diff --git a/src/IGESToBRep/IGESToBRep_IGESBoundary.hxx b/src/IGESToBRep/IGESToBRep_IGESBoundary.hxx index 37fa4275d0..c80fbebc34 100644 --- a/src/IGESToBRep/IGESToBRep_IGESBoundary.hxx +++ b/src/IGESToBRep/IGESToBRep_IGESBoundary.hxx @@ -72,7 +72,7 @@ public: //! and may contain pcurves) Handle(ShapeExtend_WireData) WireData3d() const; - //! Returns the the wire from 2D curves (edges contain pcurves + //! Returns the wire from 2D curves (edges contain pcurves //! only) Handle(ShapeExtend_WireData) WireData2d() const; diff --git a/src/IntPolyh/IntPolyh_MaillageAffinage.cxx b/src/IntPolyh/IntPolyh_MaillageAffinage.cxx index f565421d72..44ffc62bea 100644 --- a/src/IntPolyh/IntPolyh_MaillageAffinage.cxx +++ b/src/IntPolyh/IntPolyh_MaillageAffinage.cxx @@ -1227,8 +1227,8 @@ Standard_Integer project6(const IntPolyh_Point &ax, } //======================================================================= //function : TriContact -//purpose : This fonction Check if two triangles are in -// contact or no, return 1 if yes, return 0 +//purpose : This function checks if two triangles are in +// contact or not, return 1 if yes, return 0 // if no. //======================================================================= Standard_Integer IntPolyh_MaillageAffinage::TriContact diff --git a/src/IntPolyh/IntPolyh_MaillageAffinage.hxx b/src/IntPolyh/IntPolyh_MaillageAffinage.hxx index 1b7841cf1b..ee78cc2fd4 100644 --- a/src/IntPolyh/IntPolyh_MaillageAffinage.hxx +++ b/src/IntPolyh/IntPolyh_MaillageAffinage.hxx @@ -39,11 +39,11 @@ public: DEFINE_STANDARD_ALLOC - + Standard_EXPORT IntPolyh_MaillageAffinage(const Handle(Adaptor3d_Surface)& S1, const Standard_Integer NbSU1, const Standard_Integer NbSV1, const Handle(Adaptor3d_Surface)& S2, const Standard_Integer NbSU2, const Standard_Integer NbSV2, const Standard_Integer PRINT); - + Standard_EXPORT IntPolyh_MaillageAffinage(const Handle(Adaptor3d_Surface)& S1, const Handle(Adaptor3d_Surface)& S2, const Standard_Integer PRINT); - + //! Makes the sampling of the surface - //! Fills the arrays with the parametric values of the sampling points (triangulation nodes). @@ -54,7 +54,7 @@ public: //! Computes points on one surface and fills an array of points; //! standard (default) method Standard_EXPORT void FillArrayOfPnt (const Standard_Integer SurfID); - + //! isShiftFwd flag is added. The purpose is to define shift //! of points along normal to the surface in this point. The //! shift length represents maximal deflection of triangulation. @@ -64,7 +64,7 @@ public: //! advanced method Standard_EXPORT void FillArrayOfPnt (const Standard_Integer SurfID, const Standard_Boolean isShiftFwd); - + //! Compute points on one surface and fill an array of points; //! If given, is the deflection tolerance of the given sampling. //! standard (default) method @@ -72,7 +72,7 @@ public: const TColStd_Array1OfReal& Upars, const TColStd_Array1OfReal& Vpars, const Standard_Real *theDeflTol = NULL); - + //! isShiftFwd flag is added. The purpose is to define shift //! of points along normal to the surface in this point. The //! shift length represents maximal deflection of triangulation. @@ -103,97 +103,90 @@ public: //! of the two bounding boxes, and mark the points of //! the two surfaces that are inside. Standard_EXPORT void CommonBox (const Bnd_Box& B1, const Bnd_Box& B2, Standard_Real& xMin, Standard_Real& yMin, Standard_Real& zMin, Standard_Real& xMax, Standard_Real& yMax, Standard_Real& zMax); - + //! Compute edges from the array of points Standard_EXPORT void FillArrayOfEdges (const Standard_Integer SurfID); - + //! Compute triangles from the array of points, and -- //! mark the triangles that use marked points by the //! CommonBox function. Standard_EXPORT void FillArrayOfTriangles (const Standard_Integer SurfID); - + //! Refine systematicaly all marked triangles of both surfaces Standard_EXPORT void CommonPartRefinement(); - + //! Refine systematicaly all marked triangles of ONE surface Standard_EXPORT void LocalSurfaceRefinement (const Standard_Integer SurfId); - + //! Compute deflection for all triangles of one //! surface,and sort min and max of deflections Standard_EXPORT void ComputeDeflections (const Standard_Integer SurfID); - + //! Refine both surfaces using BoundSortBox as -- //! rejection. The criterions used to refine a -- //! triangle are: The deflection The size of the -- //! bounding boxes (one surface may be very small //! compared to the other) Standard_EXPORT void TrianglesDeflectionsRefinementBSB(); - - //! This fonction Check if two triangles are in - //! contact or no, return 1 if yes, return 0 - //! if no. + + //! This function checks if two triangles are in contact or not, + //! return 1 if yes, return 0 if not. Standard_EXPORT Standard_Integer TriContact (const IntPolyh_Point& P1, const IntPolyh_Point& P2, const IntPolyh_Point& P3, const IntPolyh_Point& Q1, const IntPolyh_Point& Q2, const IntPolyh_Point& Q3, Standard_Real& Angle) const; - + Standard_EXPORT Standard_Integer TriangleEdgeContact (const Standard_Integer TriSurfID, const Standard_Integer EdgeIndice, const IntPolyh_Triangle& Tri1, const IntPolyh_Triangle& Tri2, const IntPolyh_Point& P1, const IntPolyh_Point& P2, const IntPolyh_Point& P3, const IntPolyh_Point& C1, const IntPolyh_Point& C2, const IntPolyh_Point& C3, const IntPolyh_Point& Pe1, const IntPolyh_Point& Pe2, const IntPolyh_Point& E, const IntPolyh_Point& N, IntPolyh_StartPoint& SP1, IntPolyh_StartPoint& SP2) const; - - //! From two triangles compute intersection points. - //! If I found more than two intersection points - //! that's mean that those triangle are coplanar + + //! From two triangles compute intersection points. + //! If we found more than two intersection points + //! that means that those triangles are coplanar Standard_EXPORT Standard_Integer StartingPointsResearch (const Standard_Integer T1, const Standard_Integer T2, IntPolyh_StartPoint& SP1, IntPolyh_StartPoint& SP2) const; - - //! from two triangles and an intersection point I - //! search the other point (if it exist). + + //! from two triangles and an intersection point I + //! search the other point (if it exists). //! This function is used by StartPointChain Standard_EXPORT Standard_Integer NextStartingPointsResearch (const Standard_Integer T1, const Standard_Integer T2, const IntPolyh_StartPoint& SPInit, IntPolyh_StartPoint& SPNext) const; - - //! Analyse each couple of triangles from the two -- - //! array of triangles, to see if they are in - //! contact, and compute the incidence. Then put - //! couples in contact in the array of couples + + //! Analyse each couple of triangles from the two -- array of triangles, + //! to see if they are in contact, and compute the incidence. + //! Then put couples in contact in the array of couples Standard_EXPORT Standard_Integer TriangleCompare(); - + //! Loop on the array of couples. Compute StartPoints. //! Try to chain the StartPoints into SectionLines or //! put the point in the ArrayOfTangentZones if //! chaining it, is not possible. Standard_EXPORT Standard_Integer StartPointsChain (IntPolyh_ArrayOfSectionLines& TSectionLines, IntPolyh_ArrayOfTangentZones& TTangentZones); - + //! Mainly used by StartPointsChain(), this function //! try to compute the next StartPoint. Standard_EXPORT Standard_Integer GetNextChainStartPoint (const IntPolyh_StartPoint& SPInit, IntPolyh_StartPoint& SPNext, IntPolyh_SectionLine& MySectionLine, IntPolyh_ArrayOfTangentZones& TTangentZones, const Standard_Boolean Prepend = Standard_False); - + Standard_EXPORT const IntPolyh_ArrayOfPoints& GetArrayOfPoints (const Standard_Integer SurfID) const; - + Standard_EXPORT const IntPolyh_ArrayOfEdges& GetArrayOfEdges (const Standard_Integer SurfID) const; - + Standard_EXPORT const IntPolyh_ArrayOfTriangles& GetArrayOfTriangles (const Standard_Integer SurfID) const; - + Standard_EXPORT Standard_Integer GetFinTE (const Standard_Integer SurfID) const; - + Standard_EXPORT Standard_Integer GetFinTT (const Standard_Integer SurfID) const; - + Standard_EXPORT Bnd_Box GetBox (const Standard_Integer SurfID) const; - + //! This method returns list of couples of contact triangles. Standard_EXPORT IntPolyh_ListOfCouples& GetCouples(); - + Standard_EXPORT void SetEnlargeZone (const Standard_Boolean EnlargeZone); - + Standard_EXPORT Standard_Boolean GetEnlargeZone() const; - + //! returns FlecheMin Standard_EXPORT Standard_Real GetMinDeflection (const Standard_Integer SurfID) const; - + //! returns FlecheMax Standard_EXPORT Standard_Real GetMaxDeflection (const Standard_Integer SurfID) const; - -protected: - - private: - Handle(Adaptor3d_Surface) MaSurface1; Handle(Adaptor3d_Surface) MaSurface2; Bnd_Box MyBox1; diff --git a/src/IntRes2d/IntRes2d_Intersection.cxx b/src/IntRes2d/IntRes2d_Intersection.cxx index 315390f695..a4a6e352de 100644 --- a/src/IntRes2d/IntRes2d_Intersection.cxx +++ b/src/IntRes2d/IntRes2d_Intersection.cxx @@ -128,10 +128,10 @@ void IntRes2d_Intersection::SetValues(const IntRes2d_Intersection& Other) { //-- parameter of the bounds of the composite Curve //-- Merge of two Intersection Segments S1 and S2 when : //-- -//-- S1 : U1First,PosU1Fisrt --> U1Last,PosU1Last -//-- V1First,PosV1Fisrt --> V1Last,PosV1Last -//-- S2 : U2First,PosU2Fisrt --> U2Last,PosU2Last -//-- V2First,PosV2Fisrt --> V2Last,PosV2Last +//-- S1 : U1First,PosU1First --> U1Last,PosU1Last +//-- V1First,PosV1First --> V1Last,PosV1Last +//-- S2 : U2First,PosU2First --> U2Last,PosU2Last +//-- V2First,PosV2First --> V2Last,PosV2Last //-- //-- 1 U : X------1-------E H-----2-------X U --> //-- V : X------1-------X X-----2-------X <- V -> ? diff --git a/src/IntTools/IntTools_FaceFace.hxx b/src/IntTools/IntTools_FaceFace.hxx index 33204ce7cc..9a74f94b39 100644 --- a/src/IntTools/IntTools_FaceFace.hxx +++ b/src/IntTools/IntTools_FaceFace.hxx @@ -73,14 +73,11 @@ public: //! Returns True if faces are tangent Standard_EXPORT Standard_Boolean TangentFaces() const; - //! Provides post-processing the result lines. - //! - the flag. - //! In case of is true the closed 3D-curves will be splitted - //! on parts. - //! In case of is false the closed 3D-curves remain untouched. + //! @param bToSplit [in] split the closed 3D-curves on parts when TRUE, + //! remain untouched otherwise Standard_EXPORT void PrepareLines3D (const Standard_Boolean bToSplit = Standard_True); - + Standard_EXPORT void SetList (IntSurf_ListOfPntOn2S& ListOfPnts); diff --git a/src/Law/Law.hxx b/src/Law/Law.hxx index 28b4e0a959..b23b1c24ff 100644 --- a/src/Law/Law.hxx +++ b/src/Law/Law.hxx @@ -65,10 +65,10 @@ public: Standard_EXPORT static Handle(TColStd_HArray1OfReal) MixBnd (const Standard_Integer Degree, const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults, const Handle(Law_Linear)& Lin); //! Builds the poles of the 1d bspline that is null on the - //! rigth side of Knots(Index) (on the left if + //! right side of Knots(Index) (on the left if //! NulOnTheRight is false) and that is like a //! t*(1-t)(1-t) curve on the left side of Knots(Index) - //! (on the rigth if NulOnTheRight is false). The result + //! (on the right if NulOnTheRight is false). The result //! curve is C1 with a derivative equal to 1. at first //! parameter (-1 at last parameter if NulOnTheRight is //! false). diff --git a/src/Law/Law_BSpFunc.hxx b/src/Law/Law_BSpFunc.hxx index 755795feb5..06967499e8 100644 --- a/src/Law/Law_BSpFunc.hxx +++ b/src/Law/Law_BSpFunc.hxx @@ -42,7 +42,6 @@ class Law_BSpFunc : public Law_Function public: - Standard_EXPORT Law_BSpFunc(); Standard_EXPORT Law_BSpFunc(const Handle(Law_BSpline)& C, const Standard_Real First, const Standard_Real Last); @@ -52,14 +51,11 @@ public: //! Returns the number of intervals for continuity //! . May be one if Continuity(me) >= Standard_EXPORT Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE; - - //! Stores in the parameters bounding the intervals - //! of continuity . - //! - //! The array must provide enough room to accomodate - //! for the parameters. i.e. T.Length() > NbIntervals() + + //! Stores in the parameters bounding the intervals of continuity . + //! The array must provide enough room to accommodate for the parameters, i.e. T.Length() > NbIntervals() Standard_EXPORT void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - + Standard_EXPORT Standard_Real Value (const Standard_Real X) Standard_OVERRIDE; Standard_EXPORT void D1 (const Standard_Real X, Standard_Real& F, Standard_Real& D) Standard_OVERRIDE; @@ -80,30 +76,14 @@ public: Standard_EXPORT void SetCurve (const Handle(Law_BSpline)& C); - - - DEFINE_STANDARD_RTTIEXT(Law_BSpFunc,Law_Function) -protected: - - - - private: - Handle(Law_BSpline) curv; Standard_Real first; Standard_Real last; - }; - - - - - - #endif // _Law_BSpFunc_HeaderFile diff --git a/src/Law/Law_BSpline.hxx b/src/Law/Law_BSpline.hxx index 3c0cbf0217..d8548612b4 100644 --- a/src/Law/Law_BSpline.hxx +++ b/src/Law/Law_BSpline.hxx @@ -68,7 +68,7 @@ DEFINE_STANDARD_HANDLE(Law_BSpline, Standard_Transient) //! - Quasi-uniform if all multiplicities are 1 //! but the first and the last which are Degree+1. //! -//! - PiecewiseBezier if all multiplicites are +//! - PiecewiseBezier if all multiplicities are //! Degree but the first and the last which are //! Degree+1. //! @@ -518,7 +518,7 @@ public: //! StartingCondition = 1 means the first point and tangent cannot move //! EndingCondition = 1 means the last point and tangent cannot move //! and so forth - //! ErrorStatus != 0 means that there are not enought degree of freedom + //! ErrorStatus != 0 means that there are not enough degree of freedom //! with the constrain to deform the curve accordingly Standard_EXPORT void MovePointAndTangent (const Standard_Real U, const Standard_Real NewValue, const Standard_Real Derivative, const Standard_Real Tolerance, const Standard_Integer StartingCondition, const Standard_Integer EndingCondition, Standard_Integer& ErrorStatus); diff --git a/src/Law/Law_Composite.hxx b/src/Law/Law_Composite.hxx index 0ffcbda7e9..ed72b6c9b9 100644 --- a/src/Law/Law_Composite.hxx +++ b/src/Law/Law_Composite.hxx @@ -48,36 +48,34 @@ class Law_Composite : public Law_Function public: - + //! Construct an empty Law Standard_EXPORT Law_Composite(); - - //! Construct an empty, trimed Law + + //! Construct an empty, trimmed Law Standard_EXPORT Law_Composite(const Standard_Real First, const Standard_Real Last, const Standard_Real Tol); - + Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE; - + //! Returns the number of intervals for continuity //! . May be one if Continuity(me) >= Standard_EXPORT Standard_Integer NbIntervals (const GeomAbs_Shape S) const Standard_OVERRIDE; - - //! Stores in the parameters bounding the intervals - //! of continuity . - //! - //! The array must provide enough room to accomodate - //! for the parameters. i.e. T.Length() > NbIntervals() + + //! Stores in the parameters bounding the intervals of continuity . + //! The array must provide enough room to accommodate for the parameters, + //! i.e. T.Length() > NbIntervals() Standard_EXPORT void Intervals (TColStd_Array1OfReal& T, const GeomAbs_Shape S) const Standard_OVERRIDE; - + //! Returns the value at parameter X. Standard_EXPORT Standard_Real Value (const Standard_Real X) Standard_OVERRIDE; - + //! Returns the value and the first derivative at parameter X. Standard_EXPORT void D1 (const Standard_Real X, Standard_Real& F, Standard_Real& D) Standard_OVERRIDE; - + //! Returns the value, first and second derivatives //! at parameter X. Standard_EXPORT void D2 (const Standard_Real X, Standard_Real& F, Standard_Real& D, Standard_Real& D2) Standard_OVERRIDE; - + //! Returns a law equivalent of between //! parameters and . is used to //! test for 3d points confusion. @@ -85,33 +83,24 @@ public: //! in these values and if //! the Law is not Cn. Standard_EXPORT Handle(Law_Function) Trim (const Standard_Real PFirst, const Standard_Real PLast, const Standard_Real Tol) const Standard_OVERRIDE; - + //! Returns the parametric bounds of the function. Standard_EXPORT void Bounds (Standard_Real& PFirst, Standard_Real& PLast) Standard_OVERRIDE; - + //! Returns the elementary function of the composite used //! to compute at parameter W. Standard_EXPORT Handle(Law_Function)& ChangeElementaryLaw (const Standard_Real W); - + Standard_EXPORT Law_Laws& ChangeLaws(); - + Standard_EXPORT Standard_Boolean IsPeriodic() const; - + Standard_EXPORT void SetPeriodic(); - - - DEFINE_STANDARD_RTTIEXT(Law_Composite,Law_Function) -protected: - - - - private: - //! Set the current function. Standard_EXPORT void Prepare (Standard_Real& W); @@ -124,13 +113,6 @@ private: Standard_Real TLast; Standard_Real PTol; - }; - - - - - - #endif // _Law_Composite_HeaderFile diff --git a/src/Law/Law_Function.hxx b/src/Law/Law_Function.hxx index 03e255001f..c5305d8b25 100644 --- a/src/Law/Law_Function.hxx +++ b/src/Law/Law_Function.hxx @@ -44,11 +44,9 @@ public: //! . May be one if Continuity(me) >= Standard_EXPORT virtual Standard_Integer NbIntervals (const GeomAbs_Shape S) const = 0; - //! Stores in the parameters bounding the intervals - //! of continuity . - //! - //! The array must provide enough room to accomodate - //! for the parameters. i.e. T.Length() > NbIntervals() + //! Stores in the parameters bounding the intervals of continuity . + //! 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; //! Returns the value of the function at the point of parameter X. diff --git a/src/LocOpe/FILES b/src/LocOpe/FILES index 14c1f84a45..8d69105694 100644 --- a/src/LocOpe/FILES +++ b/src/LocOpe/FILES @@ -50,7 +50,6 @@ LocOpe_SequenceOfLin.hxx LocOpe_SequenceOfPntFace.hxx LocOpe_SplitDrafts.cxx LocOpe_SplitDrafts.hxx -LocOpe_SplitDrafts.lxx LocOpe_Spliter.cxx LocOpe_Spliter.hxx LocOpe_Spliter.lxx diff --git a/src/LocOpe/LocOpe_CSIntersector.hxx b/src/LocOpe/LocOpe_CSIntersector.hxx index e88ef821f2..249e01ffc9 100644 --- a/src/LocOpe/LocOpe_CSIntersector.hxx +++ b/src/LocOpe/LocOpe_CSIntersector.hxx @@ -78,7 +78,7 @@ public: //! On the element of range , searches the first //! intersection point located after the parameter - //! , wich orientation is not TopAbs_EXTERNAL. + //! , which orientation is not TopAbs_EXTERNAL. //! If found, returns . contains //! the orientation of the point, and //! represents the interval of index in the @@ -91,7 +91,7 @@ public: //! On the element of range , searches the first //! intersection point located before the parameter - //! , wich orientation is not TopAbs_EXTERNAL. + //! , which orientation is not TopAbs_EXTERNAL. //! If found, returns . contains //! the orientation of the point, and //! represents the interval of index in the @@ -104,7 +104,7 @@ public: //! On the element of range , searches the first //! intersection point located after the index - //! ( >= FromInd + 1), wich orientation is + //! ( >= FromInd + 1), which orientation is //! not TopAbs_EXTERNAL. If found, returns //! . contains the orientation of //! the point, and represents the @@ -118,7 +118,7 @@ public: //! On the element of range , searches the first //! intersection point located before the index - //! ( <= FromInd -1), wich orientation is + //! ( <= FromInd -1), which orientation is //! not TopAbs_EXTERNAL. If found, returns //! . contains the orientation of //! the point, and represents the diff --git a/src/LocOpe/LocOpe_CurveShapeIntersector.hxx b/src/LocOpe/LocOpe_CurveShapeIntersector.hxx index 7562e0518d..ffdf37dae8 100644 --- a/src/LocOpe/LocOpe_CurveShapeIntersector.hxx +++ b/src/LocOpe/LocOpe_CurveShapeIntersector.hxx @@ -75,7 +75,7 @@ public: const LocOpe_PntFace& Point (const Standard_Integer Index) const; //! Searches the first intersection point located - //! after the parameter , wich orientation is + //! after the parameter , which orientation is //! not TopAbs_EXTERNAL. If found, returns //! . contains the orientation of //! the point, and represents the @@ -87,7 +87,7 @@ public: Standard_EXPORT Standard_Boolean LocalizeAfter (const Standard_Real From, TopAbs_Orientation& Or, Standard_Integer& IndFrom, Standard_Integer& IndTo) const; //! Searches the first intersection point located - //! before the parameter , wich orientation is + //! before the parameter , which orientation is //! not TopAbs_EXTERNAL. If found, returns //! . contains the orientation of //! the point, and represents the @@ -99,7 +99,7 @@ public: Standard_EXPORT Standard_Boolean LocalizeBefore (const Standard_Real From, TopAbs_Orientation& Or, Standard_Integer& IndFrom, Standard_Integer& IndTo) const; //! Searches the first intersection point located - //! after the index ( >= FromInd + 1), wich + //! after the index ( >= FromInd + 1), which //! orientation is not TopAbs_EXTERNAL. If found, //! returns . contains the //! orientation of the point, and @@ -111,7 +111,7 @@ public: Standard_EXPORT Standard_Boolean LocalizeAfter (const Standard_Integer FromInd, TopAbs_Orientation& Or, Standard_Integer& IndFrom, Standard_Integer& IndTo) const; //! Searches the first intersection point located - //! before the index ( <= FromInd -1), wich + //! before the index ( <= FromInd -1), which //! orientation is not TopAbs_EXTERNAL. If found, //! returns . contains the //! orientation of the point, and diff --git a/src/LocOpe/LocOpe_Generator.cxx b/src/LocOpe/LocOpe_Generator.cxx index 4debc420e9..f439bb3ea6 100644 --- a/src/LocOpe/LocOpe_Generator.cxx +++ b/src/LocOpe/LocOpe_Generator.cxx @@ -14,7 +14,7 @@ // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. -// Modifed: Portage NT 7-5-97 DPF (return NewParameter) +#include #include #include @@ -35,7 +35,6 @@ #include #include #include -#include #include #include #include diff --git a/src/LocOpe/LocOpe_SplitDrafts.hxx b/src/LocOpe/LocOpe_SplitDrafts.hxx index b8725fc761..10c035bd13 100644 --- a/src/LocOpe/LocOpe_SplitDrafts.hxx +++ b/src/LocOpe/LocOpe_SplitDrafts.hxx @@ -20,23 +20,16 @@ #include #include #include - +#include #include #include -#include -#include #include -class StdFail_NotDone; -class Standard_NoSuchObject; -class Standard_ConstructionError; -class Standard_NullObject; -class TopoDS_Shape; + class TopoDS_Face; class TopoDS_Wire; class gp_Dir; class gp_Pln; - //! This class provides a tool to realize the //! following operations on a shape : //! - split a face of the shape with a wire, @@ -48,14 +41,13 @@ public: DEFINE_STANDARD_ALLOC - //! Empty constructor. - LocOpe_SplitDrafts(); + LocOpe_SplitDrafts() {} + + //! Creates the algorithm on the shape . + LocOpe_SplitDrafts(const TopoDS_Shape& S) : myShape (S) {} - //! Creates the algoritm on the shape . - LocOpe_SplitDrafts(const TopoDS_Shape& S); - - //! Initializes the algoritm with the shape . + //! Initializes the algorithm with the shape . Standard_EXPORT void Init (const TopoDS_Shape& S); //! Splits the face of the former given shape with @@ -85,43 +77,23 @@ public: //! angle. Standard_EXPORT void Perform (const TopoDS_Face& F, const TopoDS_Wire& W, const gp_Dir& Extract, const gp_Pln& NPl, const Standard_Real Angle); - //! Returns if the modification has - //! been succesfully performed. - Standard_Boolean IsDone() const; - - const TopoDS_Shape& OriginalShape() const; - + //! Returns if the modification has been successfully performed. + Standard_Boolean IsDone() const { return !myResult.IsNull(); } + + const TopoDS_Shape& OriginalShape() const { return myShape; } + //! Returns the modified shape. Standard_EXPORT const TopoDS_Shape& Shape() const; - + //! Manages the descendant shapes. Standard_EXPORT const TopTools_ListOfShape& ShapesFromShape (const TopoDS_Shape& S) const; - - - -protected: - - - - - private: - - TopoDS_Shape myShape; TopoDS_Shape myResult; TopTools_DataMapOfShapeListOfShape myMap; - }; - -#include - - - - - #endif // _LocOpe_SplitDrafts_HeaderFile diff --git a/src/LocOpe/LocOpe_SplitDrafts.lxx b/src/LocOpe/LocOpe_SplitDrafts.lxx deleted file mode 100644 index 590e85ca72..0000000000 --- a/src/LocOpe/LocOpe_SplitDrafts.lxx +++ /dev/null @@ -1,54 +0,0 @@ -// Created on: 1996-10-02 -// Created by: Jacques GOUSSARD -// Copyright (c) 1996-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. - -//======================================================================= -//function : LocOpe_SplitDrafts -//purpose : -//======================================================================= - -inline LocOpe_SplitDrafts::LocOpe_SplitDrafts () -{} - - -//======================================================================= -//function : LocOpe_SplitDrafts -//purpose : -//======================================================================= - -inline LocOpe_SplitDrafts::LocOpe_SplitDrafts (const TopoDS_Shape& S): - myShape(S) -{} - - -//======================================================================= -//function : IsDone -//purpose : -//======================================================================= - -inline Standard_Boolean LocOpe_SplitDrafts::IsDone() const -{ - return (!myResult.IsNull()); -} - -//======================================================================= -//function : OriginalShape -//purpose : -//======================================================================= - -inline const TopoDS_Shape& LocOpe_SplitDrafts::OriginalShape () const -{ - return myShape; -} diff --git a/src/LocOpe/LocOpe_WiresOnShape.hxx b/src/LocOpe/LocOpe_WiresOnShape.hxx index 144cb7a8fb..9a51b4e964 100644 --- a/src/LocOpe/LocOpe_WiresOnShape.hxx +++ b/src/LocOpe/LocOpe_WiresOnShape.hxx @@ -53,7 +53,7 @@ public: Standard_EXPORT void Init (const TopoDS_Shape& S); //! Add splitting edges or wires for whole initial shape - //! withot additional specification edge->face, edge->edge + //! without additional specification edge->face, edge->edge //! This method puts edge on the corresponding faces from initial shape Standard_EXPORT Standard_Boolean Add(const TopTools_SequenceOfShape& theEdges); diff --git a/src/LocalAnalysis/LocalAnalysis.hxx b/src/LocalAnalysis/LocalAnalysis.hxx index 2090d4ee80..bee3542421 100644 --- a/src/LocalAnalysis/LocalAnalysis.hxx +++ b/src/LocalAnalysis/LocalAnalysis.hxx @@ -20,15 +20,13 @@ #include #include #include - #include + class LocalAnalysis_SurfaceContinuity; class LocalAnalysis_CurveContinuity; class LocalAnalysis_SurfaceContinuity; class LocalAnalysis_CurveContinuity; - - //! This package gives tools to check the local continuity //! between two points situated on two curves or two surfaces. class LocalAnalysis @@ -37,42 +35,21 @@ public: DEFINE_STANDARD_ALLOC - - - //! This class compute - //! s and gives tools to check the local - //! continuity between two points situated on 2 curves) + //! This class compute s and gives tools to check the local + //! continuity between two points situated on 2 curves. //! - //! This fonction gives informations about a variable CurveContinuity + //! This function gives information about a variable CurveContinuity Standard_EXPORT static void Dump (const LocalAnalysis_SurfaceContinuity& surfconti, Standard_OStream& o); - //! This fonction gives informations about a variable SurfaceContinuity + //! This function gives information about a variable SurfaceContinuity Standard_EXPORT static void Dump (const LocalAnalysis_CurveContinuity& curvconti, Standard_OStream& o); - - - -protected: - - - - - private: - - - friend class LocalAnalysis_SurfaceContinuity; friend class LocalAnalysis_CurveContinuity; }; - - - - - - #endif // _LocalAnalysis_HeaderFile diff --git a/src/MeshVS/MeshVS_DataSource.hxx b/src/MeshVS/MeshVS_DataSource.hxx index 75a61c8c24..0b3736a5da 100644 --- a/src/MeshVS/MeshVS_DataSource.hxx +++ b/src/MeshVS/MeshVS_DataSource.hxx @@ -60,10 +60,10 @@ public: //! Returns geometry information about node or element //! ID is the numerical identificator of node or element //! IsElement indicates this ID describe node ( if Standard_False ) or element ( if Standard_True ) - //! Coords is an array of co-ordinates of node(s). + //! Coords is an array of coordinates of node(s). //! For node it is only 3 numbers: X, Y, Z in the strict order //! For element it is 3*n numbers, where n is number of this element vertices - //! The order is strict also: X1, Y1, Z1, X2,...., where Xi, Yi, Zi are co-ordinates of vertices + //! The order is strict also: X1, Y1, Z1, X2,...., where Xi, Yi, Zi are coordinates of vertices //! NbNodes is number of nodes. It is recommended this parameter to be set to 1 for node. //! Type is type of node or element (from enumeration). It is recommended this parameter to be set to //! MeshVS_ET_Node for node. @@ -101,7 +101,7 @@ public: //! There is default method, for advance reflection this method can be redefined. //! Id is the numerical identificator of only element! //! Max is maximal number of nodes an element can consist of - //! nx, ny, nz are values whose represent co-ordinates of normal (will be returned) + //! nx, ny, nz are values whose represent coordinates of normal (will be returned) //! In the redefined method you can return normal with length more then 1, but in this case //! the appearance of element will be more bright than usual. For ordinary brightness you must return //! normal with length 1 @@ -160,7 +160,7 @@ public: //! Returns maps of entities (nodes and elements) detected //! by mouse selection with rectangular box (XMin, YMin, XMax, YMax) - //! on the current veiw plane, with the tolerance aTol. + //! on the current view plane, with the tolerance aTol. //! Returns True if something is detected. //! It should be redefined if the advanced mesh selection is //! activated. Default implementation returns False. @@ -168,7 +168,7 @@ public: //! Returns maps of entities (nodes and elements) detected //! by mouse selection with the polyline - //! on the current veiw plane, with the tolerance aTol. + //! on the current view plane, with the tolerance aTol. //! Returns True if something is detected. //! It should be redefined if the advanced mesh selection is //! activated. Default implementation returns False. @@ -182,27 +182,8 @@ public: //! activated. Default implementation returns False. Standard_EXPORT virtual Standard_Boolean GetDetectedEntities (const Handle(MeshVS_Mesh)& Prs, Handle(TColStd_HPackedMapOfInteger)& Nodes, Handle(TColStd_HPackedMapOfInteger)& Elements); - - - DEFINE_STANDARD_RTTIEXT(MeshVS_DataSource,Standard_Transient) -protected: - - - - -private: - - - - }; - - - - - - #endif // _MeshVS_DataSource_HeaderFile diff --git a/src/MeshVS/MeshVS_MeshPrsBuilder.hxx b/src/MeshVS/MeshVS_MeshPrsBuilder.hxx index 818c90c931..cc55e9c951 100644 --- a/src/MeshVS/MeshVS_MeshPrsBuilder.hxx +++ b/src/MeshVS/MeshVS_MeshPrsBuilder.hxx @@ -39,7 +39,6 @@ class MeshVS_MeshPrsBuilder : public MeshVS_PrsBuilder public: - //! Creates builder with certain display mode flags, data source, ID and priority Standard_EXPORT MeshVS_MeshPrsBuilder(const Handle(MeshVS_Mesh)& Parent, const MeshVS_DisplayModeFlags& Flags = MeshVS_DMF_OCCMask, const Handle(MeshVS_DataSource)& DS = 0, const Standard_Integer Id = -1, const MeshVS_BuilderPriority& Priority = MeshVS_BP_Mesh); @@ -61,14 +60,10 @@ public: //! Calculate how many polygons or polylines are necessary to draw passed topology Standard_EXPORT static void HowManyPrimitives (const Handle(MeshVS_HArray1OfSequenceOfInteger)& Topo, const Standard_Boolean AsPolygons, const Standard_Boolean IsSelect, const Standard_Integer NbNodes, Standard_Integer& Vertices, Standard_Integer& Bounds); - - - DEFINE_STANDARD_RTTIEXT(MeshVS_MeshPrsBuilder,MeshVS_PrsBuilder) protected: - //! Add to array of polylines some lines representing link Standard_EXPORT void AddLinkPrs (const TColStd_Array1OfReal& theCoords, const Handle(Graphic3d_ArrayOfSegments)& theLines, const Standard_Boolean IsShrinked, const Standard_Real ShrinkCoef) const; @@ -80,26 +75,13 @@ protected: //! Draw array of polygons and polylines in the certain order according to transparency Standard_EXPORT void DrawArrays (const Handle(Prs3d_Presentation)& Prs, const Handle(Graphic3d_ArrayOfPrimitives)& thePolygons, const Handle(Graphic3d_ArrayOfPrimitives)& theLines, const Handle(Graphic3d_ArrayOfPrimitives)& theLinkLines, const Handle(Graphic3d_ArrayOfPrimitives)& theVolumesInShad, const Standard_Boolean IsPolygonsEdgesOff, const Standard_Boolean IsSelected, const Handle(Graphic3d_AspectFillArea3d)& theFillAsp, const Handle(Graphic3d_AspectLine3d)& theLineAsp) const; - + //! Default calculation of center of face or link. This method if useful for shrink mode presentation - //! theCoords is array of nodes co-ordinates in the strict order X1, Y1, Z1, X2... + //! theCoords is array of nodes coordinates in the strict order X1, Y1, Z1, X2... //! NbNodes is number of nodes an element consist of - //! xG, yG, zG are co-ordinates of center whose will be returned + //! xG, yG, zG are coordinates of center whose will be returned Standard_EXPORT static void CalculateCenter (const TColStd_Array1OfReal& theCoords, const Standard_Integer NbNodes, Standard_Real& xG, Standard_Real& yG, Standard_Real& zG); - - -private: - - - - }; - - - - - - #endif // _MeshVS_MeshPrsBuilder_HeaderFile diff --git a/src/Message/Message_AttributeMeter.hxx b/src/Message/Message_AttributeMeter.hxx index 222b6b102e..504a7a4eeb 100644 --- a/src/Message/Message_AttributeMeter.hxx +++ b/src/Message/Message_AttributeMeter.hxx @@ -76,7 +76,7 @@ public: static void StopAlert (const Handle(Message_AlertExtended)& theAlert) { SetAlertMetrics (theAlert, Standard_False); } //! Sets current values of default report metrics into the alert. - //! Processed oly alert with Message_AttributeMeter attribute + //! Processed only alert with Message_AttributeMeter attribute //! @param theAlert an alert //! @param theStartValue flag, if true, the start value is collected otherwise stop static Standard_EXPORT void SetAlertMetrics (const Handle(Message_AlertExtended)& theAlert, diff --git a/src/Message/Message_MsgFile.hxx b/src/Message/Message_MsgFile.hxx index 4e9494e138..22d90d1a35 100644 --- a/src/Message/Message_MsgFile.hxx +++ b/src/Message/Message_MsgFile.hxx @@ -56,7 +56,6 @@ public: DEFINE_STANDARD_ALLOC - //! Load message file from directory //! or its sub-directory Standard_EXPORT static Standard_Boolean Load (const Standard_CString theDirName, const Standard_CString theFileName); @@ -96,36 +95,13 @@ public: Standard_EXPORT static const TCollection_ExtendedString& Msg (const Standard_CString key); - //! Gives the text for the message identified by the keyword - //! If there are no messages with such keyword defined, - //! the error message is returned. - //! In that case reference to static string is returned, it can - //! be chenged with next call(s) to Msg(). + //! Gives the text for the message identified by the keyword . + //! If there are no messages with such keyword defined, the error message is returned. + //! In that case reference to static string is returned, it can be changed with next call(s) to Msg(). //! Note: The error message is constructed like 'Unknown message: ', and can //! itself be customized by defining message with key Message_Msg_BadKeyword. Standard_EXPORT static const TCollection_ExtendedString& Msg (const TCollection_AsciiString& key); - - - -protected: - - - - - -private: - - - - - }; - - - - - - #endif // _Message_MsgFile_HeaderFile diff --git a/src/NCollection/NCollection_Array1.hxx b/src/NCollection/NCollection_Array1.hxx index 71ec657d20..eaa47ad3e4 100644 --- a/src/NCollection/NCollection_Array1.hxx +++ b/src/NCollection/NCollection_Array1.hxx @@ -23,36 +23,28 @@ #include #include -// *********************************************** Template for Array1 class - -/** -* Purpose: The class Array1 represents unidimensional arrays -* of fixed size known at run time. -* The range of the index is user defined. -* An array1 can be constructed with a "C array". -* This functionality is useful to call methods expecting -* an Array1. It allows to carry the bounds inside the arrays. -* -* Examples: Item tab[100]; // An example with a C array -* Array1OfItem ttab (tab[0],1,100); -* -* Array1OfItem tttab (ttab(10),10,20); // a slice of ttab -* -* If you want to reindex an array from 1 to Length do : -* -* Array1 tab1(tab(tab.Lower()),1,tab.Length()); -* -* Warning: Programs client of such a class must be independant -* of the range of the first element. Then, a C++ for -* loop must be written like this -* -* for (i = A.Lower(); i <= A.Upper(); i++) -* -* Changes: In comparison to TCollection the flag isAllocated was -* renamed into myDeletable (alike in the Array2). For naming -* compatibility the method IsAllocated remained in class along -* with IsDeletable. -*/ +//! The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. +//! The range of the index is user defined. +//! An array1 can be constructed with a "C array". +//! This functionality is useful to call methods expecting an Array1. +//! It allows to carry the bounds inside the arrays. +//! +//! Examples: +//! @code +//! Item tab[100]; // an example with a C array +//! NCollection_Array1 ttab (tab[0], 1, 100); +//! +//! NCollection_Array1 tttab (ttab(10), 10, 20); // a slice of ttab +//! @endcode +//! If you want to reindex an array from 1 to Length do: +//! @code +//! NCollection_Array1 tab1 (tab (tab.Lower()), 1, tab.Length()); +//! @endcode +//! Warning: Programs client of such a class must be independent of the range of the first element. +//! Then, a C++ for loop must be written like this +//! @code +//! for (i = A.Lower(); i <= A.Upper(); i++) +//! @endcode template class NCollection_Array1 { diff --git a/src/OSD/OSD.cxx b/src/OSD/OSD.cxx index 3a235a1d47..c150fe7e87 100644 --- a/src/OSD/OSD.cxx +++ b/src/OSD/OSD.cxx @@ -14,10 +14,10 @@ #include -// Convert Real to CString in format e with 16 significant digits. -// The decimal point character is always a period. -// The conversion is independant from current locale database - +//======================================================================= +//function : RealToCString +//purpose : +//======================================================================= Standard_Boolean OSD::RealToCString(const Standard_Real aReal, Standard_PCharacter& aString) { diff --git a/src/OSD/OSD.hxx b/src/OSD/OSD.hxx index 7ce019500c..cd077eb0e0 100644 --- a/src/OSD/OSD.hxx +++ b/src/OSD/OSD.hxx @@ -19,8 +19,8 @@ #include #include -//! Set of Operating Sytem Dependent (OSD) Tools -class OSD +//! Set of Operating System Dependent (OSD) tools. +class OSD { public: @@ -118,17 +118,17 @@ public: //! Commands the process to sleep for a number of milliseconds Standard_EXPORT static void MilliSecSleep (const Standard_Integer theMilliseconds); - //! Converts aReal into aCstring in exponential format with a period as - //! decimal point, no thousand separator and no grouping of digits. - //! The conversion is independant from the current locale + //! Converts aReal into aCstring in exponential format with a period as decimal point, + //! no thousand separator and no grouping of digits. + //! The conversion is independent from the current locale Standard_EXPORT static Standard_Boolean RealToCString (const Standard_Real aReal, Standard_PCharacter& aString); - //! Converts aCstring representing a real with a period as - //! decimal point, no thousand separator and no grouping of digits - //! into aReal . - //! The conversion is independant from the current locale. + //! Converts aCstring representing a real with a period as decimal point, + //! no thousand separator and no grouping of digits into aReal. + //! + //! The conversion is independent from the current locale. Standard_EXPORT static Standard_Boolean CStringToReal (const Standard_CString aString, Standard_Real& aReal); - + //! since Windows NT does not support 'SIGINT' signal like UNIX, //! then this method checks whether Ctrl-Break keystroke was or //! not. If yes then raises Exception_CTRL_BREAK. diff --git a/src/OSD/OSD_Directory.hxx b/src/OSD/OSD_Directory.hxx index e2bb02e311..32ae3e4344 100644 --- a/src/OSD/OSD_Directory.hxx +++ b/src/OSD/OSD_Directory.hxx @@ -31,7 +31,7 @@ public: public: //! Creates Directory object. - //! It is initiliazed to an empty name. + //! It is initialized to an empty name. Standard_EXPORT OSD_Directory(); //! Creates Directory object initialized with theName. diff --git a/src/OSD/OSD_Environment.cxx b/src/OSD/OSD_Environment.cxx index d142f03613..2a8794db65 100644 --- a/src/OSD/OSD_Environment.cxx +++ b/src/OSD/OSD_Environment.cxx @@ -289,7 +289,7 @@ TCollection_AsciiString OSD_Environment::Value() // msvc C-runtime (_wputenv()) puts variable using WinAPI internally (calls SetEnvironmentVariableW()) // and also caches its value in its own map, - // so that _wgetenv() ignores WinAPI and retieves variable from this cache. + // so that _wgetenv() ignores WinAPI and retrieves variable from this cache. // // Using _wgetenv() might lead to awkward results in context when several C-runtimes are used // at once within application or WinAPI is used directly for setting environment variable. diff --git a/src/OSD/OSD_Environment.hxx b/src/OSD/OSD_Environment.hxx index 2092362f92..a7d05ec52e 100644 --- a/src/OSD/OSD_Environment.hxx +++ b/src/OSD/OSD_Environment.hxx @@ -57,7 +57,7 @@ public: //! Changes environment variable value. //! Raises ConstructionError either if the string contains //! characters not in range of ' '...'~' or if the string - //! contains the character '$' which is forbiden. + //! contains the character '$' which is forbidden. Standard_EXPORT void SetValue (const TCollection_AsciiString& Value); //! Gets the value of an environment variable @@ -66,7 +66,7 @@ public: //! Changes environment variable name. //! Raises ConstructionError either if the string contains //! characters not in range of ' '...'~' or if the string - //! contains the character '$' which is forbiden. + //! contains the character '$' which is forbidden. Standard_EXPORT void SetName (const TCollection_AsciiString& name); //! Gets the name of . diff --git a/src/OSD/OSD_File.hxx b/src/OSD/OSD_File.hxx index 10f6a71ef2..122aa3c48f 100644 --- a/src/OSD/OSD_File.hxx +++ b/src/OSD/OSD_File.hxx @@ -159,7 +159,7 @@ public: Standard_EXPORT Standard_Boolean IsOpen() const; //! returns TRUE if the file exists and if the user - //! has the autorization to read it. + //! has the authorization to read it. Standard_EXPORT Standard_Boolean IsReadable(); //! returns TRUE if the file can be read and overwritten. @@ -170,7 +170,7 @@ public: //! Enables to emulate unix "tail -f" command. //! If a line is available in the file returns it. - //! Otherwise attemps to read again aNbTries times in the file + //! Otherwise attempts to read again aNbTries times in the file //! waiting aDelay seconds between each read. //! If meanwhile the file increases returns the next line, otherwise //! returns FALSE. diff --git a/src/OSD/OSD_FileNode.cxx b/src/OSD/OSD_FileNode.cxx index 63716b30fc..352d24e606 100644 --- a/src/OSD/OSD_FileNode.cxx +++ b/src/OSD/OSD_FileNode.cxx @@ -295,7 +295,7 @@ Quantity_Date OSD_FileNode::CreationMoment(){ // if (Failed()) Perror(); - /* Get File Informations */ + /* Get File Information */ TCollection_AsciiString aBuffer; myPath.SystemName ( aBuffer ); @@ -323,7 +323,7 @@ Quantity_Date OSD_FileNode::AccessMoment(){ // if (Failed()) Perror(); - /* Get File Informations */ + /* Get File Information */ TCollection_AsciiString aBuffer; myPath.SystemName ( aBuffer ); diff --git a/src/OSD/OSD_FileSystem.hxx b/src/OSD/OSD_FileSystem.hxx index f37bfdc00f..744fe8f916 100644 --- a/src/OSD/OSD_FileSystem.hxx +++ b/src/OSD/OSD_FileSystem.hxx @@ -39,7 +39,7 @@ public: //! Default implementation create a stream from file buffer returned by OSD_FileSystem::OpenFileBuffer(). //! @param theUrl [in] path to open //! @param theMode [in] flags describing the requested input mode for the stream (std::ios_base::in will be implicitly added) - //! @param theOffset [in] expected stream position from the begining of the file (beginning of the stream by default); + //! @param theOffset [in] expected stream position from the beginning of the file (beginning of the stream by default); //! -1 would keep seek position undefined (in case of re-using theOldStream) //! @param theOldStream [in] a pointer to existing stream pointing to theUrl to be reused (without re-opening) //! @return pointer to newly created opened stream, to theOldStream if it can be reused or NULL in case of failure. @@ -52,7 +52,7 @@ public: //! Opens stream buffer for specified file URL. //! @param theUrl [in] path to open //! @param theMode [in] flags describing the requested input mode for the stream - //! @param theOffset [in] expected stream position from the begining of the buffer (beginning of the stream buffer by default) + //! @param theOffset [in] expected stream position from the beginning of the buffer (beginning of the stream buffer by default) //! @param theOutBufSize [out] total buffer size (only if buffer is opened for read) //! @return pointer to newly created opened stream buffer or NULL in case of failure. virtual opencascade::std::shared_ptr OpenStreamBuffer (const TCollection_AsciiString& theUrl, diff --git a/src/OSD/OSD_MAllocHook.hxx b/src/OSD/OSD_MAllocHook.hxx index 175a58857a..a9a1c63a9f 100644 --- a/src/OSD/OSD_MAllocHook.hxx +++ b/src/OSD/OSD_MAllocHook.hxx @@ -142,7 +142,7 @@ public: Standard_Mutex myMutex; //!< used for thread-safe access Numbers* myArray; //!< indexed from 0 to myMaxAllocSize-1 ptrdiff_t myTotalLeftSize; //!< currently remained allocated size - size_t myTotalPeakSize; //!< maxium cumulative allocated size + size_t myTotalPeakSize; //!< maximum cumulative allocated size size_t myBreakSize; //!< user defined allocation size to debug (see place_for_breakpoint()) size_t myBreakPeak; //!< user defined peak size limit to debug }; diff --git a/src/OSD/OSD_Parallel.cxx b/src/OSD/OSD_Parallel.cxx index 30fc2ad279..519518012c 100644 --- a/src/OSD/OSD_Parallel.cxx +++ b/src/OSD/OSD_Parallel.cxx @@ -205,7 +205,7 @@ void OSD_Parallel::SetUseOcctThreads (Standard_Boolean theToUseOcct) //======================================================================= //function : NbLogicalProcessors -//purpose : Returns number of logical proccessors. +//purpose : Returns number of logical processors. //======================================================================= Standard_Integer OSD_Parallel::NbLogicalProcessors() { diff --git a/src/OSD/OSD_Parallel.hxx b/src/OSD/OSD_Parallel.hxx index 90708bbc97..0900cd4dff 100644 --- a/src/OSD/OSD_Parallel.hxx +++ b/src/OSD/OSD_Parallel.hxx @@ -187,7 +187,7 @@ protected: }; //! Interface class representing functor object. - //! Intended to add polymorphic behavour to For and ForEach functionality + //! Intended to add polymorphic behaviour to For and ForEach functionality //! enabling execution of arbitrary function in parallel mode. class FunctorInterface { diff --git a/src/OSD/OSD_Parallel_Threads.cxx b/src/OSD/OSD_Parallel_Threads.cxx index 5041dee8b7..05066a0066 100644 --- a/src/OSD/OSD_Parallel_Threads.cxx +++ b/src/OSD/OSD_Parallel_Threads.cxx @@ -76,7 +76,7 @@ namespace private: //! @name private fields - const OSD_Parallel::UniversalIterator& myBegin; //!< Fisrt element of range. + const OSD_Parallel::UniversalIterator& myBegin; //!< First element of range. const OSD_Parallel::UniversalIterator& myEnd; //!< Last element of range. mutable OSD_Parallel::UniversalIterator myIt; //!< First non processed element of range. mutable Standard_Mutex myMutex; //!< Access controller for the first non processed element. diff --git a/src/OSD/OSD_Path.cxx b/src/OSD/OSD_Path.cxx index 271a878508..eab689b75b 100644 --- a/src/OSD/OSD_Path.cxx +++ b/src/OSD/OSD_Path.cxx @@ -298,7 +298,7 @@ static void MacExtract(const TCollection_AsciiString& what, Standard_Integer pos; Standard_PCharacter p; - // I don't know how to distingish a disk from a trek ! + // I don't know how to distinguish a disk from a trek ! trek = what; @@ -612,7 +612,7 @@ static void P2DOS (TCollection_AsciiString & Way){ -// Convert a path to system dependant syntax +// Convert a path to system dependent syntax void OSD_Path::SystemName (TCollection_AsciiString& FullName, const OSD_SysType aType)const{ diff --git a/src/OSD/OSD_Path.hxx b/src/OSD/OSD_Path.hxx index 011b2a0aeb..13804571ec 100644 --- a/src/OSD/OSD_Path.hxx +++ b/src/OSD/OSD_Path.hxx @@ -32,7 +32,7 @@ public: //! i.e. current directory. Standard_EXPORT OSD_Path(); - //! Creates a Path object initialized by dependant path. + //! Creates a Path object initialized by dependent path. //! ex: OSD_Path me ("/usr/bin/myprog.sh",OSD_UnixBSD); //! //! OSD_Path me ("sys$common:[syslib]cc.exe",OSD_OSF) will diff --git a/src/OSD/OSD_ThreadFunction.hxx b/src/OSD/OSD_ThreadFunction.hxx index 2fd6c524ce..9b30d160b2 100644 --- a/src/OSD/OSD_ThreadFunction.hxx +++ b/src/OSD/OSD_ThreadFunction.hxx @@ -18,26 +18,21 @@ #include -// Typedef for prototype of function to be used as main -// function of a thread - -// Note: currently we use the same prototype for thread functions on all -// platforms, in order to make user programs less platform-dependent. -// However, there is a distinction in returned value for the thread function -// on UNIX/Linux (void*) and WIndows (DWORD) systems. -// Thus on Windows we have to encode returned void* as DWORD. It is OK for WIN32, -// but potentially problem on WIN64. -// To avoid any problems with this, for better application portability it is recomended -// that the thread function returns just integer (casted to void*). -// This shall work on all platforms. - -//#ifdef _WIN32 -//#include -//typedef LPTHREAD_START_ROUTINE OSD_ThreadFunction; -//#else - +//! Typedef for prototype of function to be used as main function of a thread. +//! +//! Note: currently we use the same prototype for thread functions on all platforms, +//! in order to make user programs less platform-dependent. +//! However, there is a distinction in returned value for the thread function +//! on UNIX/Linux (void*) and Windows (DWORD) systems. +//! Thus on Windows we have to encode returned void* as DWORD. +//! It is OK for WIN32, but potentially problem on WIN64. +//! To avoid any problems with this, for better application portability it is recommended +//! that the thread function returns just integer (casted to void*). +//! This shall work on all platforms. typedef Standard_Address (*OSD_ThreadFunction) (Standard_Address data); +//#ifdef _WIN32 +//typedef LPTHREAD_START_ROUTINE OSD_ThreadFunction; //#endif #endif diff --git a/src/OSD/OSD_WNT.cxx b/src/OSD/OSD_WNT.cxx index f7acbd190f..a44d285b7c 100644 --- a/src/OSD/OSD_WNT.cxx +++ b/src/OSD/OSD_WNT.cxx @@ -17,8 +17,8 @@ /******************************************************************************/ /* File: OSD_WNT.cxx */ -/* Purpose: Security management routines ( more convinient than WIN32 */ -/* ones ) and other convinient functions. */ +/* Purpose: Security management routines ( more convenient than WIN32 */ +/* ones ) and other convrnient functions. */ /******************************************************************************/ /***/ #include @@ -970,7 +970,7 @@ retry: /***/ /******************************************************************************/ /* Function : SetMoveDirectoryProc */ -/* Purpose : Sets callback procedure which is calling by the */ +/* Purpose : Sets callback procedure which is calling by the */ /* 'MoveDirectory' after moving of each item in the */ /* directory. To unregister this callback function supply NULL */ /* pointer */ @@ -984,7 +984,7 @@ void SetMoveDirectoryProc ( MOVE_DIR_PROC proc ) { /***/ /******************************************************************************/ /* Function : SetCopyDirectoryProc */ -/* Purpose : Sets callback procedure which is calling by the */ +/* Purpose : Sets callback procedure which is calling by the */ /* 'CopyDirectory' after copying of each item in the */ /* directory. To unregister this callback function supply NULL */ /* pointer */ @@ -998,10 +998,10 @@ void SetCopyDirectoryProc ( COPY_DIR_PROC proc ) { /***/ /******************************************************************************/ /* Function : SetResponseDirectoryProc */ -/* Purpose : Sets callback procedure which is calling by the */ -/* directoy processing function if an error was occur. */ +/* Purpose : Sets callback procedure which is calling by the */ +/* directory processing function if an error was occur. */ /* The return value of that callback procedure determines */ -/* behaviour of directoy processing functions in case of error. */ +/* behaviour of directory processing functions in case of error. */ /* To unregister this callback function supply NULL pointer */ /******************************************************************************/ /***/ diff --git a/src/OSD/OSD_signal.cxx b/src/OSD/OSD_signal.cxx index 5c4d7b2629..007f5ccaa9 100644 --- a/src/OSD/OSD_signal.cxx +++ b/src/OSD/OSD_signal.cxx @@ -250,7 +250,7 @@ static LONG CallHandler (DWORD theExceptionCode, } case EXCEPTION_PRIV_INSTRUCTION: { - strcat_s (aBuffer, sizeof(aBuffer), "PRIVELEGED INSTRUCTION ENCOUNTERED"); + strcat_s (aBuffer, sizeof(aBuffer), "PRIVILEGED INSTRUCTION ENCOUNTERED"); break; } case EXCEPTION_STACK_OVERFLOW: @@ -467,7 +467,7 @@ void OSD::SetSignal (OSD_SignalMode theSignalMode, TCollection_AsciiString val = env.Value(); if (!env.Failed()) { - std::cout << "Environment variable CSF_DEBUG_MODE setted.\n"; + std::cout << "Environment variable CSF_DEBUG_MODE set.\n"; fMsgBox = Standard_True; if (OSD_SignalStackTraceLength == 0) { @@ -769,7 +769,7 @@ typedef void (* SIG_PFV) (int); //============================================================================ //==== Handler -//==== Catche the differents signals: +//==== Catch the different signals: //==== 1- The Fatal signals, which cause the end of process: //==== 2- The exceptions which are "signaled" by Raise. //==== The Fatal Signals: @@ -802,7 +802,7 @@ static void Handler (const int theSignal) perror ("sigaction"); } - // std::cout << "OSD::Handler: signal " << (int) theSignal << " occured inside a try block " << std::endl ; + // std::cout << "OSD::Handler: signal " << (int) theSignal << " occurred inside a try block " << std::endl ; if ( ADR_ACT_SIGIO_HANDLER != NULL ) (*ADR_ACT_SIGIO_HANDLER)() ; @@ -1029,7 +1029,7 @@ void OSD::SetThreadLocalSignal (OSD_SignalMode /*theSignalMode*/, //============================================================================ //==== SetSignal -//==== Set the differents signals: +//==== Set the different signals: //============================================================================ void OSD::SetSignal (OSD_SignalMode theSignalMode, diff --git a/src/OpenGl/OpenGl_Caps.hxx b/src/OpenGl/OpenGl_Caps.hxx index d940260811..dc46fd5099 100755 --- a/src/OpenGl/OpenGl_Caps.hxx +++ b/src/OpenGl/OpenGl_Caps.hxx @@ -114,7 +114,7 @@ public: //! @name context creation parameters * but some limit functionality to OpenGL 2.1 (e.g. OS X) when core profile is not explicitly requested. * * Requires OpenGL 3.2+ drivers. - * Has no effect on OpenGL ES 2.0+ drivers (which do not provie FFP compatibility). + * Has no effect on OpenGL ES 2.0+ drivers (which do not provide FFP compatibility). * Interacts with ffpEnable option, which should be disabled within core profile. * * ON by default. diff --git a/src/OpenGl/OpenGl_Context.cxx b/src/OpenGl/OpenGl_Context.cxx index 39996e7244..3303db61b5 100644 --- a/src/OpenGl/OpenGl_Context.cxx +++ b/src/OpenGl/OpenGl_Context.cxx @@ -2182,7 +2182,7 @@ void OpenGl_Context::ReleaseDelayed() { if (++anIter.ChangeValue() <= 2) { - continue; // postpone release one more frame to ensure noone use it periodically + continue; // postpone release one more frame to ensure no one uses it periodically } const TCollection_AsciiString& aKey = anIter.Key(); diff --git a/src/OpenGl/OpenGl_GraduatedTrihedron.cxx b/src/OpenGl/OpenGl_GraduatedTrihedron.cxx index 78b4eea5fa..d599a153e2 100755 --- a/src/OpenGl/OpenGl_GraduatedTrihedron.cxx +++ b/src/OpenGl/OpenGl_GraduatedTrihedron.cxx @@ -188,7 +188,7 @@ Standard_ShortReal OpenGl_GraduatedTrihedron::getDistanceToCorner (const OpenGl_ Standard_ExtCharacter OpenGl_GraduatedTrihedron::getGridAxes (const Standard_ShortReal theCorners[8], GridAxes& theGridAxes) const { - // Find the farest corner + // Find the farthest corner Standard_Byte aMaxIndex = 0; Standard_ShortReal aMax = theCorners[aMaxIndex] > 0.0f ? theCorners[aMaxIndex] : 0.0f; @@ -581,7 +581,7 @@ void OpenGl_GraduatedTrihedron::Render (const Handle(OpenGl_Workspace)& theWorks } } - // Find the farest point of bounding box + // Find the farthest point of bounding box // Get normal of the view out of user and distance corresponding to 1 pixel OpenGl_Vec3 aNormal; @@ -607,7 +607,7 @@ void OpenGl_GraduatedTrihedron::Render (const Handle(OpenGl_Workspace)& theWorks // (0, 0, 1), (0, 1, 0) and (0, 0, 1) directions from (myMin.x(), Ymin, Zmin) point // are reserved for trihedron axes. // So for the grid here are 9 edges of cube, - // and, depending on the farest point, 2 or 3 of them may not be drawn + // and, depending on the farthest point, 2 or 3 of them may not be drawn // if they overlap displayed model. // Write an axes state what axes of bounding box are to be drawn diff --git a/src/OpenGl/OpenGl_GraduatedTrihedron.hxx b/src/OpenGl/OpenGl_GraduatedTrihedron.hxx index f6b8e3149e..c18c94efc6 100755 --- a/src/OpenGl/OpenGl_GraduatedTrihedron.hxx +++ b/src/OpenGl/OpenGl_GraduatedTrihedron.hxx @@ -163,7 +163,7 @@ private: //! Render line from the transformed primitive array myLine //! @param theWorkspace [in] the OpenGl Workspace - //! @param theMat [in] theMat that containes base transformation and is used for appling + //! @param theMat [in] theMat that contains base transformation and is used for applying //! translation and rotation //! @param thaTx the X for vector of translation //! @param thaTy the Y for vector of translation @@ -179,7 +179,7 @@ private: //! @param theWorkspace [in] the OpenGl Workspace //! @param theIndex [in] index of axis //! @param theGridAxes [in] grid axes - //! @param theMat [in] theMat that containes base transformation and is used for appling + //! @param theMat [in] theMat that contains base transformation and is used for applying //! translation and rotation void renderGridPlane (const Handle(OpenGl_Workspace)& theWorkspace, const Standard_Integer& theIndex, @@ -190,7 +190,7 @@ private: //! Render the axis of input index //! @param theWorkspace [in] the OpenGl Workspace //! @param theIndex [in] index of axis - //! @param theMat [in] theMat that containes base transformation and is used for appling + //! @param theMat [in] theMat that contains base transformation and is used for applying //! translation and rotation void renderAxis (const Handle(OpenGl_Workspace)& theWorkspace, const Standard_Integer& theIndex, @@ -198,7 +198,7 @@ private: //! Render grid labels, tickmark lines and labels //! @param theWorkspace [in] the OpenGl Workspace - //! @param theMat [in] theMat that containes base transformation and is used for appling + //! @param theMat [in] theMat that contains base transformation and is used for applying //! translation and rotation //! @param theIndex [in] index of axis //! @param theGridAxes [in] grid axes diff --git a/src/OpenGl/OpenGl_TextBuilder.hxx b/src/OpenGl/OpenGl_TextBuilder.hxx index 2fcd775e33..caa0c7ce14 100644 --- a/src/OpenGl/OpenGl_TextBuilder.hxx +++ b/src/OpenGl/OpenGl_TextBuilder.hxx @@ -43,7 +43,7 @@ public: NCollection_Vector& theVertsPerTexture, NCollection_Vector& theTCrdsPerTexture); -protected: //! @name class auxillary methods +protected: //! @name class auxiliary methods Standard_EXPORT void createGlyphs (const Handle(Font_TextFormatter)& theFormatter, const Handle(OpenGl_Context)& theCtx, @@ -52,7 +52,7 @@ protected: //! @name class auxillary methods NCollection_Vector< NCollection_Handle < NCollection_Vector > >& theVertsPerTexture, NCollection_Vector< NCollection_Handle < NCollection_Vector > >& theTCrdsPerTexture); -protected: //! @name class auxillary fields +protected: //! @name class auxiliary fields NCollection_Vector myTileRects; OpenGl_VertexBufferEditor myVboEditor; diff --git a/src/OpenGl/OpenGl_View.hxx b/src/OpenGl/OpenGl_View.hxx index 583bc2cfff..a56410944e 100644 --- a/src/OpenGl/OpenGl_View.hxx +++ b/src/OpenGl/OpenGl_View.hxx @@ -221,7 +221,7 @@ public: //! Returns background image texture map. virtual Handle(Graphic3d_TextureMap) BackgroundImage() Standard_OVERRIDE { return myBackgroundImage; } - //! Sets image texture or environment cubemap as backround. + //! Sets image texture or environment cubemap as background. //! @param theTextureMap [in] source to set a background; //! should be either Graphic3d_Texture2D or Graphic3d_CubeMap //! @param theToUpdatePBREnv [in] defines whether IBL maps will be generated or not diff --git a/src/math/math_FunctionSet.hxx b/src/math/math_FunctionSet.hxx index 540968b6f3..7080c88d21 100644 --- a/src/math/math_FunctionSet.hxx +++ b/src/math/math_FunctionSet.hxx @@ -28,7 +28,7 @@ //! This abstract class describes the virtual functions associated to -//! a set on N Functions of M independant variables. +//! a set on N Functions of M independent variables. class math_FunctionSet { public: diff --git a/src/math/math_FunctionSetWithDerivatives.hxx b/src/math/math_FunctionSetWithDerivatives.hxx index 9be28f80cf..0e89635f1a 100644 --- a/src/math/math_FunctionSetWithDerivatives.hxx +++ b/src/math/math_FunctionSetWithDerivatives.hxx @@ -29,7 +29,7 @@ class math_Matrix; //! This abstract class describes the virtual functions associated -//! with a set of N Functions each of M independant variables. +//! with a set of N Functions each of M independent variables. class math_FunctionSetWithDerivatives : public math_FunctionSet { public: diff --git a/src/math/math_IntegerVector.hxx b/src/math/math_IntegerVector.hxx index 9e223fddbb..3ff5d0f017 100644 --- a/src/math/math_IntegerVector.hxx +++ b/src/math/math_IntegerVector.hxx @@ -31,7 +31,7 @@ //! math_IntegerVector V1(-3, 5); // an IntegerVector with range [-3..5] //! @endcode //! -//! IntegerVector is copied through assignement : +//! IntegerVector is copied through assignment: //! @code //! math_IntegerVector V2( 1, 9); //! .... diff --git a/src/math/math_Matrix.hxx b/src/math/math_Matrix.hxx index 819b8ca05b..b8cb70c5c0 100644 --- a/src/math/math_Matrix.hxx +++ b/src/math/math_Matrix.hxx @@ -42,36 +42,43 @@ //! of definition of the matrix. //! Matrix objects follow "value semantics", that is, they //! cannot be shared and are copied through assignment -//! Matrices are copied through assignement: +//! Matrices are copied through assignment: +//! @code //! math_Matrix M2(1, 9, 1, 3); //! ... //! M2 = M1; //! M1(1) = 2.0;//the matrix M2 will not be modified. -//! +//! @endcode //! The exception RangeError is raised when trying to access //! outside the range of a matrix : +//! @code //! M1(11, 1)=0.0// --> will raise RangeError. +//! @endcode //! //! The exception DimensionError is raised when the dimensions of //! two matrices or vectors are not compatible. +//! @code //! math_Matrix M3(1, 2, 1, 2); //! M3 = M1; // will raise DimensionError //! M1.Add(M3) // --> will raise DimensionError. -//! A Matrix can be constructed with a a pointer to "c array". +//! @endcode +//! A Matrix can be constructed with a pointer to "c array". //! It allows to carry the bounds inside the matrix. -//! Exemple : +//! Example : +//! @code //! Standard_Real tab1[10][20]; //! Standard_Real tab2[200]; //! //! math_Matrix A (tab1[0][0], 1, 10, 1, 20); //! math_Matrix B (tab2[0], 1, 10, 1, 20); -class math_Matrix +//! @endcode +class math_Matrix { public: DEFINE_STANDARD_ALLOC - + //! Constructs a non-initialized matrix of range [LowerRow..UpperRow, //! LowerCol..UpperCol] //! For the constructed matrix: @@ -80,24 +87,24 @@ public: //! - LowerCol and UpperCol are the indexes of the //! lower and upper bounds of a column. Standard_EXPORT math_Matrix(const Standard_Integer LowerRow, const Standard_Integer UpperRow, const Standard_Integer LowerCol, const Standard_Integer UpperCol); - + //! constructs a non-initialized matrix of range [LowerRow..UpperRow, //! LowerCol..UpperCol] //! whose values are all initialized with the value InitialValue. Standard_EXPORT math_Matrix(const Standard_Integer LowerRow, const Standard_Integer UpperRow, const Standard_Integer LowerCol, const Standard_Integer UpperCol, const Standard_Real InitialValue); - + //! constructs a matrix of range [LowerRow..UpperRow, //! LowerCol..UpperCol] //! Sharing data with a "C array" pointed by Tab. Standard_EXPORT math_Matrix(const Standard_Address Tab, const Standard_Integer LowerRow, const Standard_Integer UpperRow, const Standard_Integer LowerCol, const Standard_Integer UpperCol); - + //! constructs a matrix for copy in initialization. //! An exception is raised if the matrixes have not the same dimensions. Standard_EXPORT math_Matrix(const math_Matrix& Other); - + //! Initialize all the elements of a matrix to InitialValue. Standard_EXPORT void Init (const Standard_Real InitialValue); - + //! Returns the number of rows of this matrix. //! Note that for a matrix A you always have the following relations: //! - A.RowNumber() = A.UpperRow() - A.LowerRow() + 1 @@ -106,7 +113,7 @@ public: //! - the length of a column of A is equal to the number of //! rows of A.returns the row range of a matrix. Standard_Integer RowNumber() const; - + //! Returns the number of rows of this matrix. //! Note that for a matrix A you always have the following relations: //! - A.RowNumber() = A.UpperRow() - A.LowerRow() + 1 @@ -115,36 +122,36 @@ public: //! - the length of a column of A is equal to the number of //! rows of A.returns the row range of a matrix. Standard_Integer ColNumber() const; - + //! Returns the value of the Lower index of the row //! range of a matrix. Standard_Integer LowerRow() const; - + //! Returns the Upper index of the row range //! of a matrix. Standard_Integer UpperRow() const; - + //! Returns the value of the Lower index of the //! column range of a matrix. Standard_Integer LowerCol() const; - + //! Returns the value of the upper index of the //! column range of a matrix. Standard_Integer UpperCol() const; - + //! Computes the determinant of a matrix. //! An exception is raised if the matrix is not a square matrix. Standard_EXPORT Standard_Real Determinant() const; - + //! Transposes a given matrix. //! An exception is raised if the matrix is not a square matrix. Standard_EXPORT void Transpose(); - + //! Inverts a matrix using Gauss algorithm. //! Exception NotSquare is raised if the matrix is not square. //! Exception SingularMatrix is raised if the matrix is singular. Standard_EXPORT void Invert(); - + //! Sets this matrix to the product of the matrix Left, and the matrix Right. //! Example //! math_Matrix A (1, 3, 1, 3); @@ -167,7 +174,7 @@ void operator*= (const Standard_Real Right) { Multiply(Right); } - + //! multiplies all the elements of a matrix by the //! value . Standard_NODISCARD Standard_EXPORT math_Matrix Multiplied (const Standard_Real Right) const; @@ -175,7 +182,7 @@ Standard_NODISCARD math_Matrix operator* (const Standard_Real Right) const { return Multiplied(Right); } - + //! Sets this matrix to the product of the //! transposed matrix TLeft, and the matrix Right. //! Example @@ -196,7 +203,7 @@ Standard_NODISCARD math_Matrix operator* (const Standard_Real Right) const //! the number of columns of this matrix. Standard_NODISCARD Standard_EXPORT math_Matrix TMultiplied (const Standard_Real Right) const; friend math_Matrix operator *(const Standard_Real Left,const math_Matrix& Right); - + //! divides all the elements of a matrix by the value . //! An exception is raised if = 0. Standard_EXPORT void Divide (const Standard_Real Right); @@ -204,7 +211,7 @@ void operator/= (const Standard_Real Right) { Divide(Right); } - + //! divides all the elements of a matrix by the value . //! An exception is raised if = 0. Standard_NODISCARD Standard_EXPORT math_Matrix Divided (const Standard_Real Right) const; @@ -212,7 +219,7 @@ Standard_NODISCARD math_Matrix operator/ (const Standard_Real Right) const { return Divided(Right); } - + //! adds the matrix to a matrix. //! An exception is raised if the dimensions are different. //! Warning @@ -224,7 +231,7 @@ void operator+= (const math_Matrix& Right) { Add(Right); } - + //! adds the matrix to a matrix. //! An exception is raised if the dimensions are different. Standard_NODISCARD Standard_EXPORT math_Matrix Added (const math_Matrix& Right) const; @@ -232,11 +239,11 @@ Standard_NODISCARD math_Matrix operator+ (const math_Matrix& Right) const { return Added(Right); } - + //! sets a matrix to the addition of and . //! An exception is raised if the dimensions are different. Standard_EXPORT void Add (const math_Matrix& Left, const math_Matrix& Right); - + //! Subtracts the matrix from . //! An exception is raised if the dimensions are different. //! Warning @@ -248,7 +255,7 @@ void operator-= (const math_Matrix& Right) { Subtract(Right); } - + //! Returns the result of the subtraction of from . //! An exception is raised if the dimensions are different. Standard_NODISCARD Standard_EXPORT math_Matrix Subtracted (const math_Matrix& Right) const; @@ -256,7 +263,7 @@ Standard_NODISCARD math_Matrix operator- (const math_Matrix& Right) const { return Subtracted(Right); } - + //! Sets the values of this matrix, //! - from index I1 to index I2 on the row dimension, and //! - from index J1 to index J2 on the column dimension, @@ -270,71 +277,71 @@ Standard_NODISCARD math_Matrix operator- (const math_Matrix& Right) const //! - I2 - I1 + 1 is not equal to the number of rows of matrix M, or //! - J2 - J1 + 1 is not equal to the number of columns of matrix M. Standard_EXPORT void Set (const Standard_Integer I1, const Standard_Integer I2, const Standard_Integer J1, const Standard_Integer J2, const math_Matrix& M); - + //! Sets the row of index Row of a matrix to the vector . //! An exception is raised if the dimensions are different. //! An exception is raises if is inferior to the lower //! row of the matrix or is superior to the upper row. Standard_EXPORT void SetRow (const Standard_Integer Row, const math_Vector& V); - + //! Sets the column of index Col of a matrix to the vector . //! An exception is raised if the dimensions are different. //! An exception is raises if is inferior to the lower //! column of the matrix or is superior to the upper //! column. Standard_EXPORT void SetCol (const Standard_Integer Col, const math_Vector& V); - + //! Sets the diagonal of a matrix to the value . //! An exception is raised if the matrix is not square. Standard_EXPORT void SetDiag (const Standard_Real Value); - + //! Returns the row of index Row of a matrix. Standard_EXPORT math_Vector Row (const Standard_Integer Row) const; - + //! Returns the column of index of a matrix. Standard_EXPORT math_Vector Col (const Standard_Integer Col) const; - + //! Swaps the rows of index Row1 and Row2. //! An exception is raised if or is out of range. Standard_EXPORT void SwapRow (const Standard_Integer Row1, const Standard_Integer Row2); - + //! Swaps the columns of index and . //! An exception is raised if or is out of range. Standard_EXPORT void SwapCol (const Standard_Integer Col1, const Standard_Integer Col2); - + //! Teturns the transposed of a matrix. //! An exception is raised if the matrix is not a square matrix. Standard_NODISCARD Standard_EXPORT math_Matrix Transposed() const; - + //! Returns the inverse of a matrix. //! Exception NotSquare is raised if the matrix is not square. //! Exception SingularMatrix is raised if the matrix is singular. Standard_EXPORT math_Matrix Inverse() const; - + //! Returns the product of the transpose of a matrix with //! the matrix . //! An exception is raised if the dimensions are different. Standard_EXPORT math_Matrix TMultiply (const math_Matrix& Right) const; - + //! Computes a matrix as the product of 2 vectors. //! An exception is raised if the dimensions are different. //! = * . Standard_EXPORT void Multiply (const math_Vector& Left, const math_Vector& Right); - + //! Computes a matrix as the product of 2 matrixes. //! An exception is raised if the dimensions are different. Standard_EXPORT void Multiply (const math_Matrix& Left, const math_Matrix& Right); - + //! Computes a matrix to the product of the transpose of //! the matrix with the matrix . //! An exception is raised if the dimensions are different. Standard_EXPORT void TMultiply (const math_Matrix& TLeft, const math_Matrix& Right); - + //! Sets a matrix to the Subtraction of the matrix //! from the matrix . //! An exception is raised if the dimensions are different. Standard_EXPORT void Subtract (const math_Matrix& Left, const math_Matrix& Right); - + //! Accesses (in read or write mode) the value of index //! and of a matrix. //! An exception is raised if and are not @@ -344,15 +351,15 @@ Standard_NODISCARD math_Matrix operator- (const math_Matrix& Right) const { return Value(Row,Col); } - - //! Matrixes are copied through assignement. + + //! Matrixes are copied through assignment. //! An exception is raised if the dimensions are different. Standard_EXPORT math_Matrix& Initialized (const math_Matrix& Other); math_Matrix& operator= (const math_Matrix& Other) { return Initialized(Other); } - + //! Returns the product of 2 matrices. //! An exception is raised if the dimensions are different. Standard_EXPORT void Multiply (const math_Matrix& Right); @@ -360,7 +367,7 @@ void operator*= (const math_Matrix& Right) { Multiply(Right); } - + //! Returns the product of 2 matrices. //! An exception is raised if the dimensions are different. Standard_NODISCARD Standard_EXPORT math_Matrix Multiplied (const math_Matrix& Right) const; @@ -368,7 +375,7 @@ Standard_NODISCARD math_Matrix operator* (const math_Matrix& Right) const { return Multiplied(Right); } - + //! Returns the product of a matrix by a vector. //! An exception is raised if the dimensions are different. Standard_NODISCARD Standard_EXPORT math_Vector Multiplied (const math_Vector& Right) const; @@ -376,7 +383,7 @@ Standard_NODISCARD math_Vector operator* (const math_Vector& Right) const { return Multiplied(Right); } - + //! Returns the opposite of a matrix. //! An exception is raised if the dimensions are different. Standard_EXPORT math_Matrix Opposite(); @@ -384,7 +391,7 @@ math_Matrix operator-() { return Opposite(); } - + //! Prints information on the current state of the object. //! Is used to redefine the operator <<. Standard_EXPORT void Dump (Standard_OStream& o) const; @@ -395,14 +402,14 @@ friend class math_Vector; protected: - + //! The new lower row of the matrix is set to Standard_EXPORT void SetLowerRow (const Standard_Integer LowerRow); - + //! The new lower column of the matrix is set to the column //! of range . Standard_EXPORT void SetLowerCol (const Standard_Integer LowerCol); - + //! The new lower row of the matrix is set to //! and the new lower column of the matrix is set to the column //! of range . diff --git a/src/math/math_Uzawa.hxx b/src/math/math_Uzawa.hxx index 17032030f1..025ed74f97 100644 --- a/src/math/math_Uzawa.hxx +++ b/src/math/math_Uzawa.hxx @@ -57,7 +57,7 @@ public: //! The tolerance EpsLic is fixed for the dual variable //! convergence. The tolerance EpsLix is used for the //! convergence of X. - //! Exception ConstuctionError is raised if the line number + //! Exception ConstructionError is raised if the line number //! of Cont is different from the length of Secont. Standard_EXPORT math_Uzawa(const math_Matrix& Cont, const math_Vector& Secont, const math_Vector& StartingPoint, const Standard_Real EpsLix = 1.0e-06, const Standard_Real EpsLic = 1.0e-06, const Standard_Integer NbIterations = 500); @@ -72,7 +72,7 @@ public: //! convergence. The tolerance EpsLix is used for the //! convergence of X. //! There are no conditions on Nce and Nci. - //! Exception ConstuctionError is raised if the line number + //! Exception ConstructionError is raised if the line number //! of Cont is different from the length of Secont and from //! Nce + Nci. Standard_EXPORT math_Uzawa(const math_Matrix& Cont, const math_Vector& Secont, const math_Vector& StartingPoint, const Standard_Integer Nci, const Standard_Integer Nce, const Standard_Real EpsLix = 1.0e-06, const Standard_Real EpsLic = 1.0e-06, const Standard_Integer NbIterations = 500); diff --git a/src/math/math_Vector.hxx b/src/math/math_Vector.hxx index c4d7069b48..15b86ccd34 100644 --- a/src/math/math_Vector.hxx +++ b/src/math/math_Vector.hxx @@ -34,7 +34,7 @@ class math_Matrix; //! math_Vector V1(-3, 5); // a vector with range [-3..5] //! @endcode //! -//! Vector are copied through assignement : +//! Vector are copied through assignment: //! @code //! math_Vector V2( 1, 9); //! ....