// File generated by CPPExt (Value)
//
//                     Copyright (C) 1991 - 2000 by  
//                      Matra Datavision SA.  All rights reserved.
//  
//                     Copyright (C) 2001 - 2004 by
//                     Open CASCADE SA.  All rights reserved.
// 
// This file is part of the Open CASCADE Technology software.
//
// This software may be distributed and/or modified under the terms and
// conditions of the Open CASCADE Public License as defined by Open CASCADE SA
// and appearing in the file LICENSE included in the packaging of this file.
//  
// This software is distributed on an "AS IS" basis, without warranty of any
// kind, and Open CASCADE SA hereby disclaims all such warranties,
// including without limitation, any warranties of merchantability, fitness
// for a particular purpose or non-infringement. Please see the License for
// the specific terms and conditions governing rights and limitations under the
// License.

#ifndef _math_BissecNewton_HeaderFile
#define _math_BissecNewton_HeaderFile

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _math_Status_HeaderFile
#include <math_Status.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
class StdFail_NotDone;
class math_FunctionWithDerivative;


#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif


//! This class implements a combination of Newton-Raphson and bissection <br>
//!  methods to find the root of the function between two bounds. <br>
//! Knowledge of the derivative is required. <br>
class math_BissecNewton  {

public:

    void* operator new(size_t,void* anAddress) 
      {
        return anAddress;
      }
    void* operator new(size_t size) 
      { 
        return Standard::Allocate(size); 
      }
    void  operator delete(void *anAddress) 
      { 
        if (anAddress) Standard::Free((Standard_Address&)anAddress); 
      }
 // Methods PUBLIC
 // 


//! A combination of Newton-Raphson and bissection methods is done to find <br>
//! the root of the function F between the bounds Bound1 and Bound2. <br>
//! on the function F. <br>
//! The tolerance required on the root is given by TolX. <br>
//! The solution is found when : <br>
//!    abs(Xi - Xi-1) <= TolX and F(Xi) * F(Xi-1) <= 0 <br>
//! The maximum number of iterations allowed is given by NbIterations. <br>
Standard_EXPORT math_BissecNewton(math_FunctionWithDerivative& F,const Standard_Real Bound1,const Standard_Real Bound2,const Standard_Real TolX,const Standard_Integer NbIterations = 100);


//! This method is called at the end of each iteration to check if the <br>
//! solution has been found. <br>
//! It can be redefined in a sub-class to implement a specific test to <br>
//! stop the iterations. <br>
Standard_EXPORT virtual  Standard_Boolean IsSolutionReached(math_FunctionWithDerivative& F) ;
//! Tests is the root has been successfully found. <br>
  Standard_Boolean IsDone() const;
//! returns the value of the root. <br>
//! Exception NotDone is raised if the minimum was not found. <br>
  Standard_Real Root() const;
//! returns the value of the derivative at the root. <br>
//! Exception NotDone is raised if the minimum was not found. <br>
  Standard_Real Derivative() const;
//! returns the value of the function at the root. <br>
//! Exception NotDone is raised if the minimum was not found. <br>
  Standard_Real Value() const;

//! Prints on the stream o information on the current state <br>
//!          of the object. <br>
//!          Is used to redifine the operator <<. <br>
Standard_EXPORT   void Dump(Standard_OStream& o) const;





protected:

 // Methods PROTECTED
 // 


Standard_EXPORT   void Perform(math_FunctionWithDerivative& F,const Standard_Real Bound1,const Standard_Real Bound2,const Standard_Integer NbIterations) ;


 // Fields PROTECTED
 //
math_Status TheStatus;
Standard_Real XTol;
Standard_Real x;
Standard_Real dx;
Standard_Real f;
Standard_Real df;


private: 

 // Methods PRIVATE
 // 


 // Fields PRIVATE
 //
Standard_Boolean Done;


};


#include <math_BissecNewton.lxx>



// other Inline functions and methods (like "C++: function call" methods)
//


#endif
