Class container for the Halley's method. More...

#include <Halley.hh>

Inherits Optimist::ScalarRootFinder::ScalarRootFinder< Real, Halley< Real > >.

Public Types
using	FunctionWrapper = typename ScalarRootFinder<Real, Halley<Real>>::FunctionWrapper

using	FirstDerivativeWrapper = typename ScalarRootFinder<Real, Halley<Real>>::FirstDerivativeWrapper

using	SecondDerivativeWrapper = typename ScalarRootFinder<Real, Halley<Real>>::SecondDerivativeWrapper

Public Types inherited from Optimist::ScalarRootFinder::ScalarRootFinder< Real, Halley< Real > >
using	FunctionWrapper

using	FirstDerivativeWrapper

using	SecondDerivativeWrapper

Public Member Functions
	Halley ()

std::string	name_impl () const

bool	solve_impl (FunctionWrapper function, FirstDerivativeWrapper first_derivative, SecondDerivativeWrapper second_derivative, Real x_ini, Real &x_sol)

Public Member Functions inherited from Optimist::ScalarRootFinder::ScalarRootFinder< Real, Halley< Real > >
	ScalarRootFinder ()

std::string	name () const

bool	solve (FunctionWrapper function, Real x_ini, Real &x_sol)

bool	solve (FunctionWrapper function, FirstDerivativeWrapper first_derivative, Real x_ini, Real &x_sol)

bool	solve (FunctionWrapper function, FirstDerivativeWrapper first_derivative, SecondDerivativeWrapper second_derivate, Real x_ini, Real &x_sol)

Public Member Functions inherited from Optimist::Solver< Real, 1, 1, Halley< Real > >
	Solver ()

	Solver (FunctionWrapper function, const InputType &x_ini, InputType &x_sol)

	Solver (FunctionWrapper function, FirstDerivativeWrapper first_derivative, const InputType &x_ini, InputType &x_sol)

	Solver (FunctionWrapper function, FirstDerivativeWrapper first_derivative, SecondDerivativeWrapper second_derivative, const InputType &x_ini, InputType &x_sol)

const InputType &	lower_bound () const

void	lower_bound (const InputType &t_lower_bound)

const InputType &	upper_bound () const

void	upper_bound (const InputType &t_upper_bound)

void	bounds (const InputType &t_lower_bound, const InputType &t_upper_bound)

constexpr Integer	input_dimension () const

constexpr Integer	output_dimension () const

Integer	function_evaluations () const

void	max_function_evaluations (Integer t_max_function_evaluations)

Integer	max_function_evaluations () const

Integer	iterations () const

Integer	max_iterations () const

void	max_iterations (Integer t_max_iterations)

Real	alpha () const

void	alpha (Real t_alpha)

Integer	relaxations () const

Integer	max_relaxations () const

void	max_relaxations (Integer t_max_relaxations)

Real	tolerance () const

void	tolerance (Real t_tolerance)

void	verbose_mode (bool t_verbose)

bool	verbose_mode () const

void	enable_verbose_mode ()

void	disable_verbose_mode ()

void	damped_mode (bool t_damped)

bool	damped_mode () const

void	enable_damped_mode ()

void	disable_damped_mode ()

std::string	task () const

void	task (std::string t_task)

bool	converged () const

const TraceType &	trace () const

std::ostream &	ostream () const

void	ostream (std::ostream &t_ostream)

bool	solve (FunctionWrapper function, const InputType &x_ini, InputType &x_sol)

bool	solve (FunctionWrapper function, FirstDerivativeWrapper first_derivative, const InputType &x_ini, InputType &x_sol)

bool	solve (FunctionWrapper function, FirstDerivativeWrapper first_derivative, SecondDerivativeWrapper second_derivative, const InputType &x_ini, InputType &x_sol)

bool	rootfind (Function< Real, FunInDim, FunOutDim, DerivedFunction > const &function, const InputType &x_ini, InputType &x_sol)

bool	optimize (Function< Real, FunInDim, FunOutDim, DerivedFunction > const &function, const InputType &x_ini, InputType &x_sol)

std::string	name () const

Static Public Attributes
static constexpr bool	requires_function {true}

static constexpr bool	requires_first_derivative {true}

static constexpr bool	requires_second_derivative {true}

Static Public Attributes inherited from Optimist::ScalarRootFinder::ScalarRootFinder< Real, Halley< Real > >
static constexpr bool	is_rootfinder

static constexpr bool	is_optimizer

static constexpr bool	requires_function

static constexpr bool	requires_first_derivative

static constexpr bool	requires_second_derivative

Additional Inherited Members
Public Attributes inherited from Optimist::ScalarRootFinder::ScalarRootFinder< Real, Halley< Real > >
friend	Solver< Real, 1, 1, ScalarRootFinder< Real, DerivedSolver > >

Protected Types inherited from Optimist::Solver< Real, 1, 1, Halley< Real > >
using	InputType

using	OutputType

using	TraceType

using	FirstDerivativeType

using	SecondDerivativeType

using	FunctionWrapper

using	FirstDerivativeWrapper

using	SecondDerivativeWrapper

Protected Member Functions inherited from Optimist::Solver< Real, 1, 1, Halley< Real > >
Integer	first_derivative_evaluations () const

Integer	max_first_derivative_evaluations () const

void	max_first_derivative_evaluations (Integer first_derivative_evaluations)

Integer	second_derivative_evaluations () const

Integer	max_second_derivative_evaluations () const

void	max_second_derivative_evaluations (Integer second_derivative_evaluations)

bool	solve (Function< Real, FunInDim, FunOutDim, DerivedFunction > const &function, const InputType &x_ini, InputType &x_sol, bool is_optimization)

void	reset ()

void	evaluate_function (FunctionWrapper function, const InputType &x, OutputType &out)

void	evaluate_first_derivative (FirstDerivativeWrapper function, const InputType &x, FirstDerivativeType &out)

void	evaluate_second_derivative (SecondDerivativeWrapper function, const InputType &x, SecondDerivativeType &out)

void	store_trace (const InputType &x)

bool	damp (FunctionWrapper function, InputType const &x_old, InputType const &function_old, InputType const &step_old, InputType &x_new, InputType &function_new, InputType &step_new)

void	header ()

void	bottom ()

void	info (Real residuals, std::string const &notes="-")

Protected Attributes inherited from Optimist::Solver< Real, 1, 1, Halley< Real > >
InputType	m_lower_bound

InputType	m_upper_bound

Integer	m_function_evaluations

Integer	m_first_derivative_evaluations

Integer	m_second_derivative_evaluations

Integer	m_max_function_evaluations

Integer	m_max_first_derivative_evaluations

Integer	m_max_second_derivative_evaluations

Integer	m_iterations

Integer	m_max_iterations

Real	m_alpha

Integer	m_relaxations

Integer	m_max_relaxations

Real	m_tolerance

bool	m_verbose

bool	m_damped

std::ostream *	m_ostream

std::string	m_task

bool	m_converged

TraceType	m_trace

Detailed Description

template<typename Real>
class Optimist::ScalarRootFinder::Halley< Real >

Template Parameters

Real	Scalar number type.

Member Typedef Documentation

◆ FirstDerivativeWrapper

template<typename Real>

using Optimist::ScalarRootFinder::Halley< Real >::FirstDerivativeWrapper = typename ScalarRootFinder<Real, Halley<Real>>::FirstDerivativeWrapper

◆ FunctionWrapper

template<typename Real>

using Optimist::ScalarRootFinder::Halley< Real >::FunctionWrapper = typename ScalarRootFinder<Real, Halley<Real>>::FunctionWrapper

◆ SecondDerivativeWrapper

template<typename Real>

using Optimist::ScalarRootFinder::Halley< Real >::SecondDerivativeWrapper = typename ScalarRootFinder<Real, Halley<Real>>::SecondDerivativeWrapper

Constructor & Destructor Documentation

◆ Halley()

template<typename Real>

Optimist::ScalarRootFinder::Halley< Real >::Halley ( )

inline

Class constructor for the Halley solver.

Member Function Documentation

◆ name_impl()

template<typename Real>

std::string Optimist::ScalarRootFinder::Halley< Real >::name_impl ( ) const

inline

Get the Halley solver name.

Returns: The Halley solver name.

◆ solve_impl()

template<typename Real>

bool Optimist::ScalarRootFinder::Halley< Real >::solve_impl	(	FunctionWrapper	function,
		FirstDerivativeWrapper	first_derivative,
		SecondDerivativeWrapper	second_derivative,
		Real	x_ini,
		Real &	x_sol )

inline

Solve the nonlinear equation \( f(x) = 0 \), with \( f: \mathbb{R} \rightarrow \mathbb{R} \).

Parameters

[in]	function	Function wrapper.
[in]	first_derivative	First derivative wrapper.
[in]	second_derivative	Second derivative wrapper.
[in]	x_ini	Initialization point.
[out]	x_sol	Solution point.

Returns: The convergence boolean flag.

Member Data Documentation

◆ requires_first_derivative

template<typename Real>

bool Optimist::ScalarRootFinder::Halley< Real >::requires_first_derivative {true}

staticconstexpr

◆ requires_function

template<typename Real>

bool Optimist::ScalarRootFinder::Halley< Real >::requires_function {true}

staticconstexpr

◆ requires_second_derivative

template<typename Real>

bool Optimist::ScalarRootFinder::Halley< Real >::requires_second_derivative {true}

staticconstexpr

Basic constants.

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

include/Optimist/ScalarRootFinder/Halley.hh

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FirstDerivativeWrapper

◆ FunctionWrapper

◆ SecondDerivativeWrapper

Constructor & Destructor Documentation

◆ Halley()

Member Function Documentation

◆ name_impl()

◆ solve_impl()

Member Data Documentation

◆ requires_first_derivative

◆ requires_function

◆ requires_second_derivative