BubbleProfiler::Root_finder< Vector > Class Template Reference

#include <root_finder.hpp>

Public Member Functions
virtual	~Root_finder ()=default
virtual const Vector &	get_solution () const =0
template<class F >
Root_finder_status	find_root (F &&function, const Vector &guess)

Protected Member Functions
virtual Root_finder_status	solve (const std::function< Vector(const Vector &)> &, const Vector &)=0

Detailed Description

template<class Vector>
class BubbleProfiler::Root_finder< Vector >

Definition at line 28 of file root_finder.hpp.

Constructor & Destructor Documentation

template<class Vector>

virtual BubbleProfiler::Root_finder< Vector >::~Root_finder ( )

virtualdefault

Member Function Documentation

template<class Vector>

template<class F >

Root_finder_status BubbleProfiler::Root_finder< Vector >::find_root	(	F &&	function,
		const Vector &	guess
	)

Run the root finding algorithm.

Template Parameters

F	Function data type

Parameters

function	Function to find root of
initial_guess	Starting point for the algorithm

Returns

Status indicating whether the algorithm succeeded

Definition at line 51 of file root_finder.hpp.

template<class Vector>

virtual const Vector& BubbleProfiler::Root_finder< Vector >::get_solution ( ) const

pure virtual

Implemented in BubbleProfiler::GSL_root_finder< N >.

template<class Vector>

virtual Root_finder_status BubbleProfiler::Root_finder< Vector >::solve ( const std::function< Vector(const Vector &)> &  , const Vector &    )

protectedpure virtual

---

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

• /home/michael/bubbleprofiler_release/include/root_finder.hpp