1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-06 10:36:12 +03:00
occt/src/math/math_BracketedRoot.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
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.
2014-02-20 16:15:17 +04:00

95 lines
2.7 KiB
Plaintext

-- Created on: 1991-05-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 BracketedRoot from math
---Purpose: This class implements the Brent method to find the root of a function
-- located within two bounds. No knowledge of the derivative is required.
uses Matrix from math,
Vector from math,
Function from math,
OStream from Standard
raises NotDone
is
Create(F: in out Function;
Bound1, Bound2, Tolerance: Real;
NbIterations: Integer = 100; ZEPS : Real =1.0e-12)
---Purpose:
-- The Brent method is used to find the root of the function F between
-- the bounds Bound1 and Bound2 on the function F.
-- If F(Bound1)*F(Bound2) >0 the Brent method fails.
-- The tolerance required for the root is given by Tolerance.
-- The solution is found when :
-- abs(Xi - Xi-1) <= Tolerance;
-- The maximum number of iterations allowed is given by NbIterations.
returns BracketedRoot;
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 minimum 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 minimum was not found.
---C++: inline
returns Real
raises NotDone
is static;
NbIterations(me)
---Purpose: returns the number of iterations really done during the
-- computation of the Root.
-- Exception NotDone is raised if the minimum 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 static;
fields
Done: Boolean;
TheRoot: Real;
TheError: Real;
NbIter: Integer;
end BracketedRoot;