honey::BisectN< Real, Dim > Class Template Reference

Find the root of a set of functions by the bisection method. ie. Finds (x,y,...) where all functions return 0. More...

#include <BisectN.h>

Public Types
typedef Vec< Dim, Real >	Vec
typedef function< Real(Vec)>	Func
typedef array< Func, Dim >	Funcs

Public Member Functions
	BisectN (Real tol=Real_::zeroTol, int depthMax=30)
tuple< bool, Vec >	root (const Funcs &funcs, const Vec &min, const Vec &max)
	Find the root of a set of functions within bounds [min,max]. More...

Static Public Attributes
static const int	dim = Dim

Detailed Description

template<class Real, int Dim>
class honey::BisectN< Real, Dim >

Find the root of a set of functions by the bisection method. ie. Finds (x,y,...) where all functions return 0.

Bisection should only be used if the function to be evaluated is monotonic over the range [min,max], ie. the function is either increasing or decreasing over the range.

Member Typedef Documentation

template<class Real , int Dim>

typedef function<Real (Vec)> honey::BisectN< Real, Dim >::Func

template<class Real , int Dim>

typedef array<Func, Dim> honey::BisectN< Real, Dim >::Funcs

template<class Real , int Dim>

typedef Vec<Dim, Real> honey::BisectN< Real, Dim >::Vec

Constructor & Destructor Documentation

template<class Real , int Dim>

honey::BisectN< Real, Dim >::BisectN ( Real  tol = Real_::zeroTol, int  depthMax = 30  )

inline

Parameters

tol	Find root to within tolerance of zero
depthMax	Tree is explored one path at a time using a stack, requires depthMax nodes.

Member Function Documentation

template<class Real , int Dim>

auto honey::BisectN< Real, Dim >::root	(	const Funcs &	funcs,
		const Vec &	min,
		const Vec &	max
	)

Find the root of a set of functions within bounds [min,max].

Parameters

funcs
min	root lower bound
max	root upper bound

Return values

found	if not found a best guess is returned
root

Member Data Documentation

template<class Real , int Dim>

const int honey::BisectN< Real, Dim >::dim = Dim

static

---

The documentation for this class was generated from the following files:

• src/common/Honey/Math/NumAnalysis/BisectN.h
• src/common/Honey/Math/NumAnalysis/BisectN.cpp