OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKMath
math


math_BracketMinimum Class Reference

Given two distinct initial points, BracketMinimum
implements the computation of three points (a, b, c) which
bracket the minimum of the function and verify A less than
B, B less than C and F(A) less than F(B), F(B) less than (C).
.

#include <math_BracketMinimum.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT math_BracketMinimum (math_Function &F, const Standard_Real A, const Standard_Real B)
 Given two initial values this class computes a
bracketing triplet of abscissae Ax, Bx, Cx
(such that Bx is between Ax and Cx, F(Bx) is
less than both F(Bx) and F(Cx)) the Brent minimization is done
on the function F.
.
Standard_EXPORT math_BracketMinimum (math_Function &F, const Standard_Real A, const Standard_Real B, const Standard_Real FA)
 Given two initial values this class computes a
bracketing triplet of abscissae Ax, Bx, Cx
(such that Bx is between Ax and Cx, F(Bx) is
less than both F(Bx) and F(Cx)) the Brent minimization is done
on the function F.
This constructor has to be used if F(A) is known.
.
Standard_EXPORT math_BracketMinimum (math_Function &F, const Standard_Real A, const Standard_Real B, const Standard_Real FA, const Standard_Real FB)
 Given two initial values this class computes a
bracketing triplet of abscissae Ax, Bx, Cx
(such that Bx is between Ax and Cx, F(Bx) is
less than both F(Bx) and F(Cx)) the Brent minimization is done
on the function F.
This constructor has to be used if F(A) and F(B) are known.
.
Standard_Boolean IsDone () const
 Returns true if the computations are successful, otherwise returns false.
.
Standard_EXPORT void Values (Standard_Real &A, Standard_Real &B, Standard_Real &C) const
 Returns the bracketed triplet of abscissae.
Exceptions
StdFail_NotDone if the algorithm fails (and IsDone returns false).
.
Standard_EXPORT void FunctionValues (Standard_Real &FA, Standard_Real &FB, Standard_Real &FC) const
 returns the bracketed triplet function values.
Exceptions
StdFail_NotDone if the algorithm fails (and IsDone returns false).

Standard_EXPORT void Dump (Standard_OStream &o) const
 Prints on the stream o information on the current state
of the object.
Is used to redefine the operator <<.
.

Protected Member Functions

Standard_EXPORT void Perform (math_Function &F, const Standard_Real A, const Standard_Real B)
 Is used internally by the constructors.
.

Private Attributes

Standard_Boolean Done
Standard_Real Ax
Standard_Real Bx
Standard_Real Cx
Standard_Real FAx
Standard_Real FBx
Standard_Real FCx
Standard_Boolean myFA
Standard_Boolean myFB


Constructor & Destructor Documentation

Standard_EXPORT math_BracketMinimum::math_BracketMinimum math_Function F,
const Standard_Real  A,
const Standard_Real  B
 

Standard_EXPORT math_BracketMinimum::math_BracketMinimum math_Function F,
const Standard_Real  A,
const Standard_Real  B,
const Standard_Real  FA
 

Standard_EXPORT math_BracketMinimum::math_BracketMinimum math_Function F,
const Standard_Real  A,
const Standard_Real  B,
const Standard_Real  FA,
const Standard_Real  FB
 


Member Function Documentation

Standard_EXPORT void math_BracketMinimum::Dump Standard_OStream o  )  const
 

Standard_EXPORT void math_BracketMinimum::FunctionValues Standard_Real FA,
Standard_Real FB,
Standard_Real FC
const
 

Standard_Boolean math_BracketMinimum::IsDone  )  const [inline]
 

void math_BracketMinimum::operator delete void *  anAddress  )  [inline]
 

void* math_BracketMinimum::operator new size_t  size  )  [inline]
 

void* math_BracketMinimum::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT void math_BracketMinimum::Perform math_Function F,
const Standard_Real  A,
const Standard_Real  B
[protected]
 

Standard_EXPORT void math_BracketMinimum::Values Standard_Real A,
Standard_Real B,
Standard_Real C
const
 


Field Documentation

Standard_Real math_BracketMinimum::Ax [private]
 

Standard_Real math_BracketMinimum::Bx [private]
 

Standard_Real math_BracketMinimum::Cx [private]
 

Standard_Boolean math_BracketMinimum::Done [private]
 

Standard_Real math_BracketMinimum::FAx [private]
 

Standard_Real math_BracketMinimum::FBx [private]
 

Standard_Real math_BracketMinimum::FCx [private]
 

Standard_Boolean math_BracketMinimum::myFA [private]
 

Standard_Boolean math_BracketMinimum::myFB [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:12:45 2008 for OpenCASCADE by  doxygen 1.4.1