num_collect::roots::function_root_finder_base< Derived, Function > Class Template Reference

Base class of root-finding algorithms for functions. More...

#include <num_collect/roots/function_root_finder_base.h>

Inheritance diagram for num_collect::roots::function_root_finder_base< Derived, Function >:

Collaboration diagram for num_collect::roots::function_root_finder_base< Derived, Function >:

Public Types
using	function_type = Function
	Type of function of equation.
using	variable_type = typename function_type::variable_type
	Type of variables.

Public Member Functions
	function_root_finder_base (logging::log_tag_view tag, const function_type &function=function_type())
	Constructor.
auto	function () -> function_type &
	Get the function of equation.
auto	function () const -> const function_type &
	Get the function of equation.
Public Member Functions inherited from num_collect::base::iterative_solver_base< Derived >
	iterative_solver_base (logging::log_tag_view tag)
	Constructor.
auto	is_stop_criteria_satisfied () const -> bool
	Determine if stopping criteria of the algorithm are satisfied.
void	iterate ()
	Iterate the algorithm once.
void	solve ()
	Solve the problem.
Public Member Functions inherited from num_collect::logging::logging_mixin
	logging_mixin (log_tag_view tag)
	Constructor.
template<typename Child >
void	configure_child_algorithm_logger_if_exists (Child &child)
	Configure a logger of a child algorithm if exists.
auto	logger () const noexcept -> const num_collect::logging::logger &
	Access to the logger.
auto	logger () noexcept -> num_collect::logging::logger &
	Access to the logger.
Public Member Functions inherited from num_collect::logging::iterations::iteration_logger_mixin< Derived >
	iteration_logger_mixin ()=default
	Constructor.
void	configure_iteration_logger (num_collect::logging::iterations::iteration_logger< Derived > &iteration_logger) const
	Configure an iteration logger.
auto	initialize_iteration_logger () -> num_collect::logging::iterations::iteration_logger< Derived > &
	Get the iteration logger.

Private Attributes
Function	function_
	Function of equation.

Additional Inherited Members
Protected Member Functions inherited from num_collect::base::iterative_solver_base< Derived >
auto	derived () const noexcept -> const Derived &
	Access derived object.
auto	derived () noexcept -> Derived &
	Access derived object.

Detailed Description

template<typename Derived, concepts::function Function>
class num_collect::roots::function_root_finder_base< Derived, Function >

Base class of root-finding algorithms for functions.

Template Parameters

Derived	Type of derived class.
Function	Type of the function of equation.

Definition at line 35 of file function_root_finder_base.h.

Member Typedef Documentation

function_type

template<typename Derived , concepts::function Function>

using num_collect::roots::function_root_finder_base< Derived, Function >::function_type = Function

Type of function of equation.

Definition at line 39 of file function_root_finder_base.h.

variable_type

template<typename Derived , concepts::function Function>

using num_collect::roots::function_root_finder_base< Derived, Function >::variable_type = typename function_type::variable_type

Type of variables.

Definition at line 42 of file function_root_finder_base.h.

Constructor & Destructor Documentation

function_root_finder_base()

template<typename Derived , concepts::function Function>

num_collect::roots::function_root_finder_base< Derived, Function >::function_root_finder_base ( logging::log_tag_view tag, const function_type & function = function_type() )

inlineexplicit

Constructor.

Parameters

[in]	tag	Log tag.
[in]	function	Function of equation.

Definition at line 50 of file function_root_finder_base.h.

Member Function Documentation

function() [1/2]

template<typename Derived , concepts::function Function>

auto num_collect::roots::function_root_finder_base< Derived, Function >::function ( ) -> function_type&

inlinenodiscard

Get the function of equation.

Returns

Function of equation.

Definition at line 60 of file function_root_finder_base.h.

function() [2/2]

template<typename Derived , concepts::function Function>

auto num_collect::roots::function_root_finder_base< Derived, Function >::function ( ) const -> const function_type&

inlinenodiscard

Get the function of equation.

Returns

Function of equation.

Definition at line 67 of file function_root_finder_base.h.

Member Data Documentation

function_

template<typename Derived , concepts::function Function>

Function num_collect::roots::function_root_finder_base< Derived, Function >::function_

private

Function of equation.

Definition at line 73 of file function_root_finder_base.h.

---

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

• include/num_collect/roots/function_root_finder_base.h