alg::zersol::ZeroSolver< T > Class Template Reference

The class implements the search algorithm for all zeros of a complex analytic function contained within a given rectangle. More...

#include <zerosolver.hpp>

Public Member Functions
	ZeroSolver (const Function< T > &F_, const Box< T > &B_, const Settings< T > &S_)
	A constructor of the ZeroSolver object.
	~ZeroSolver (void)
	A destructor of the ZeroSolver object.
void	print_status (std::ostream &output=std::cout) const
	Print the status of the zeros search.
int	FindZeros (const int &N, Complex *Z, Complex *V, int &n_zeros)
	Run the zeros search procedure.

Friends
std::ostream &	operator<< (std::ostream &output, const ZeroSolver< T > &ZS)
	An insertion operator to print content of the object.

Detailed Description

template<typename T = double>
class alg::zersol::ZeroSolver< T >

The class implements the search algorithm for all zeros of a complex analytic function contained within a given rectangle.

Constructor & Destructor Documentation

template<typename T = double>

alg::zersol::ZeroSolver< T >::ZeroSolver ( const Function< T > &  F_, const Box< T > &  B_, const Settings< T > &  S_  )

inline

A constructor of the ZeroSolver object.

Parameters

F_	a type::Function object that defines the analytic function
B_	a type::Box object that defines the rectangular region of a complex plane where the zeros are searched
S_	a alg::zersol::Settings object that defines all settings used by the underlying algorithms

template<typename T = double>

alg::zersol::ZeroSolver< T >::~ZeroSolver ( void  )

inline

A destructor of the ZeroSolver object.

Member Function Documentation

template<typename T = double>

void alg::zersol::ZeroSolver< T >::print_status ( std::ostream &  output = std::cout ) const

inline

Print the status of the zeros search.

Parameters

output

an output stream for the printing

template<typename T >

int alg::zersol::ZeroSolver< T >::FindZeros	(	const int &	N,
		Complex *	Z,
		Complex *	V,
		int &	n_zeros
	)

Run the zeros search procedure.

Parameters

N	length of the passed Z and V arrays
Z	array for the function zeros
V	array for the function values V = F(Z)
n_zeros	number of the zeros found

Returns

search status

Friends And Related Function Documentation

template<typename T = double>

std::ostream& operator<< ( std::ostream &  output, const ZeroSolver< T > &  ZS  )

friend

An insertion operator to print content of the object.

Parameters

output	an output stream for the insertion
ZS	a ZeroSolver object to be inserted (printed)

Returns

output stream