mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-07 18:30:55 +03:00
a5a7b3185b
Update empty method guards to new style with regex (see PR). Used clang-format 18.1.8. New actions to validate code formatting is added. Update .clang-format with disabling of include sorting. It is temporary changes, then include will be sorted. Apply formatting for /src and /tools folder. The files with .hxx,.cxx,.lxx,.h,.pxx,.hpp,*.cpp extensions.
97 lines
3.3 KiB
C++
97 lines
3.3 KiB
C++
// 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.
|
|
|
|
#ifndef _math_BissecNewton_HeaderFile
|
|
#define _math_BissecNewton_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_DefineAlloc.hxx>
|
|
#include <Standard_Handle.hxx>
|
|
|
|
#include <math_Status.hxx>
|
|
#include <Standard_Real.hxx>
|
|
#include <Standard_OStream.hxx>
|
|
class math_FunctionWithDerivative;
|
|
|
|
//! This class implements a combination of Newton-Raphson and bissection
|
|
//! methods to find the root of the function between two bounds.
|
|
//! Knowledge of the derivative is required.
|
|
class math_BissecNewton
|
|
{
|
|
public:
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
//! Constructor.
|
|
//! @param theXTolerance - algorithm tolerance.
|
|
Standard_EXPORT math_BissecNewton(const Standard_Real theXTolerance);
|
|
|
|
//! A combination of Newton-Raphson and bissection methods is done to find
|
|
//! the root of the function F between the bounds Bound1 and Bound2
|
|
//! on the function F.
|
|
//! The tolerance required on the root is given by TolX.
|
|
//! The solution is found when:
|
|
//! abs(Xi - Xi-1) <= TolX and F(Xi) * F(Xi-1) <= 0
|
|
//! The maximum number of iterations allowed is given by NbIterations.
|
|
Standard_EXPORT void Perform(math_FunctionWithDerivative& F,
|
|
const Standard_Real Bound1,
|
|
const Standard_Real Bound2,
|
|
const Standard_Integer NbIterations = 100);
|
|
|
|
//! This method is called at the end of each iteration to check if the
|
|
//! solution has been found.
|
|
//! It can be redefined in a sub-class to implement a specific test to
|
|
//! stop the iterations.
|
|
virtual Standard_Boolean IsSolutionReached(math_FunctionWithDerivative& theFunction);
|
|
|
|
//! Tests is the root has been successfully found.
|
|
Standard_Boolean IsDone() const;
|
|
|
|
//! returns the value of the root.
|
|
//! Exception NotDone is raised if the minimum was not found.
|
|
Standard_Real Root() const;
|
|
|
|
//! returns the value of the derivative at the root.
|
|
//! Exception NotDone is raised if the minimum was not found.
|
|
Standard_Real Derivative() const;
|
|
|
|
//! returns the value of the function at the root.
|
|
//! Exception NotDone is raised if the minimum was not found.
|
|
Standard_Real Value() const;
|
|
|
|
//! Prints on the stream o information on the current state
|
|
//! of the object.
|
|
//! Is used to redifine the operator <<.
|
|
Standard_EXPORT void Dump(Standard_OStream& o) const;
|
|
|
|
//! Destructor
|
|
Standard_EXPORT virtual ~math_BissecNewton();
|
|
|
|
protected:
|
|
math_Status TheStatus;
|
|
Standard_Real XTol;
|
|
Standard_Real x;
|
|
Standard_Real dx;
|
|
Standard_Real f;
|
|
Standard_Real df;
|
|
|
|
private:
|
|
Standard_Boolean Done;
|
|
};
|
|
|
|
#include <math_BissecNewton.lxx>
|
|
|
|
#endif // _math_BissecNewton_HeaderFile
|