flexiblesusy::GSL_multiroot_fsolver Class Reference

#include <gsl_multiroot_fsolver.hpp>

Collaboration diagram for flexiblesusy::GSL_multiroot_fsolver:

Public Member Functions
GSL_vector	get_root () const
	GSL_multiroot_fsolver (const GSL_multiroot_fsolver &)=delete
	GSL_multiroot_fsolver (const gsl_multiroot_fsolver_type *type, std::size_t dim, gsl_multiroot_function *f, const GSL_vector &start)
	GSL_multiroot_fsolver (GSL_multiroot_fsolver &&)=delete
int	iterate ()
GSL_multiroot_fsolver &	operator= (const GSL_multiroot_fsolver &)=delete
GSL_multiroot_fsolver &	operator= (GSL_multiroot_fsolver &&)=delete
void	print_state (std::size_t iteration) const
int	test_residual (double precision) const noexcept
	~GSL_multiroot_fsolver () noexcept

Private Attributes
gsl_multiroot_fsolver *	solver = nullptr

Detailed Description

RAII wrapper for gsl_multiroot_fsolver

Definition at line 30 of file gsl_multiroot_fsolver.hpp.

Constructor & Destructor Documentation

GSL_multiroot_fsolver() [1/3]

flexiblesusy::GSL_multiroot_fsolver::GSL_multiroot_fsolver	(	const gsl_multiroot_fsolver_type *	type,
		std::size_t	dim,
		gsl_multiroot_function *	f,
		const GSL_vector &	start
	)

Definition at line 26 of file gsl_multiroot_fsolver.cpp.

References flexiblesusy::f(), flexiblesusy::GSL_vector::raw(), and solver.

GSL_multiroot_fsolver() [2/3]

flexiblesusy::GSL_multiroot_fsolver::GSL_multiroot_fsolver ( const GSL_multiroot_fsolver &  )

delete

GSL_multiroot_fsolver() [3/3]

flexiblesusy::GSL_multiroot_fsolver::GSL_multiroot_fsolver ( GSL_multiroot_fsolver &&  )

delete

~GSL_multiroot_fsolver()

flexiblesusy::GSL_multiroot_fsolver::~GSL_multiroot_fsolver ( )

noexcept

Definition at line 41 of file gsl_multiroot_fsolver.cpp.

References solver.

Member Function Documentation

get_root()

GSL_vector flexiblesusy::GSL_multiroot_fsolver::get_root

(

)

const

Definition at line 46 of file gsl_multiroot_fsolver.cpp.

References solver.

Referenced by flexiblesusy::Root_finder< dimension >::find_root().

iterate()

int flexiblesusy::GSL_multiroot_fsolver::iterate

(

)

Definition at line 48 of file gsl_multiroot_fsolver.cpp.

References solver.

Referenced by flexiblesusy::Root_finder< dimension >::find_root().

operator=() [1/2]

GSL_multiroot_fsolver & flexiblesusy::GSL_multiroot_fsolver::operator= ( const GSL_multiroot_fsolver &  )

delete

operator=() [2/2]

GSL_multiroot_fsolver & flexiblesusy::GSL_multiroot_fsolver::operator= ( GSL_multiroot_fsolver &&  )

delete

print_state()

void flexiblesusy::GSL_multiroot_fsolver::print_state

(

std::size_t

iteration

)

const

Definition at line 53 of file gsl_multiroot_fsolver.cpp.

References solver, and VERBOSE_MSG.

Referenced by flexiblesusy::Root_finder< dimension >::find_root().

test_residual()

int flexiblesusy::GSL_multiroot_fsolver::test_residual ( double  precision ) const

noexcept

Definition at line 60 of file gsl_multiroot_fsolver.cpp.

Referenced by flexiblesusy::Root_finder< dimension >::find_root().

Member Data Documentation

solver

gsl_multiroot_fsolver* flexiblesusy::GSL_multiroot_fsolver::solver = nullptr

private

Definition at line 47 of file gsl_multiroot_fsolver.hpp.

Referenced by get_root(), GSL_multiroot_fsolver(), iterate(), print_state(), and ~GSL_multiroot_fsolver().

---

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

• gsl_multiroot_fsolver.hpp
• gsl_multiroot_fsolver.cpp