mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-04 13:13:25 +03:00
d5f74e42d6
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast Wrong license statements corrected in several files. Copyright and license statements added in XSD and GLSL files. Copyright year updated in some files. Obsolete documentation files removed from DrawResources.
126 lines
3.7 KiB
Plaintext
126 lines
3.7 KiB
Plaintext
-- Created on: 1991-03-14
|
|
-- Created by: Laurent PAINNOT
|
|
-- Copyright (c) 1991-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.
|
|
|
|
class FunctionRoot from math
|
|
---Purpose:
|
|
-- This class implements the computation of a root of a function of
|
|
-- a single variable which is near an initial guess using a minimization
|
|
-- algorithm.Knowledge of the derivative is required. The
|
|
-- algorithm used is the same as in
|
|
|
|
uses Vector from math, Matrix from math,
|
|
FunctionWithDerivative from math,
|
|
OStream from Standard
|
|
|
|
raises NotDone from StdFail
|
|
|
|
is
|
|
|
|
Create(F: in out FunctionWithDerivative;
|
|
Guess, Tolerance: Real;
|
|
NbIterations: Integer = 100)
|
|
---Purpose:
|
|
-- The Newton-Raphson method is done to find the root of the function F
|
|
-- from the initial guess Guess.The tolerance required on
|
|
-- the root is given by Tolerance. Iterations are stopped if
|
|
-- the expected solution does not stay in the range A..B.
|
|
-- The solution is found when abs(Xi - Xi-1) <= Tolerance;
|
|
-- The maximum number of iterations allowed is given by NbIterations.
|
|
|
|
returns FunctionRoot;
|
|
|
|
|
|
Create(F: in out FunctionWithDerivative;
|
|
Guess, Tolerance,A,B: Real;
|
|
NbIterations: Integer = 100)
|
|
---Purpose:
|
|
-- The Newton-Raphson method is done to find the root of the function F
|
|
-- from the initial guess Guess.
|
|
-- The tolerance required on the root is given by Tolerance.
|
|
-- Iterations are stopped if the expected solution does not stay in the
|
|
-- range A..B
|
|
-- The solution is found when abs(Xi - Xi-1) <= Tolerance;
|
|
-- The maximum number of iterations allowed is given by NbIterations.
|
|
|
|
returns FunctionRoot;
|
|
|
|
|
|
IsDone(me)
|
|
---Purpose: Returns true if the computations are successful, otherwise returns false.
|
|
---C++: inline
|
|
returns Boolean
|
|
is static;
|
|
|
|
|
|
Root(me)
|
|
---Purpose: returns the value of the root.
|
|
-- Exception NotDone is raised if the root was not found.
|
|
---C++: inline
|
|
|
|
returns Real
|
|
raises NotDone
|
|
is static;
|
|
|
|
|
|
Derivative(me)
|
|
---Purpose: returns the value of the derivative at the root.
|
|
-- Exception NotDone is raised if the root was not found.
|
|
---C++: inline
|
|
|
|
returns Real
|
|
raises NotDone
|
|
is static;
|
|
|
|
|
|
Value(me)
|
|
---Purpose: returns the value of the function at the root.
|
|
-- Exception NotDone is raised if the root was not found.
|
|
---C++: inline
|
|
|
|
returns Real
|
|
raises NotDone
|
|
is static;
|
|
|
|
|
|
NbIterations(me)
|
|
---Purpose: returns the number of iterations really done on the
|
|
-- computation of the Root.
|
|
-- Exception NotDone is raised if the root was not found.
|
|
---C++: inline
|
|
|
|
returns Integer
|
|
raises NotDone
|
|
is static;
|
|
|
|
|
|
Dump(me; o: in out OStream)
|
|
---Purpose: Prints on the stream o information on the current state
|
|
-- of the object.
|
|
-- Is used to redefine the operator <<.
|
|
|
|
is static;
|
|
|
|
|
|
fields
|
|
|
|
Done: Boolean;
|
|
TheRoot: Real ;
|
|
TheError: Real ;
|
|
TheDerivative: Real ;
|
|
NbIter: Integer;
|
|
|
|
end FunctionRoot;
|