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

The class contains settings used by the zeros search algorithm. More...

#include <zerosolver.hpp>

Public Member Functions
	Settings (bool use_winding_=true, int max_part_level_=128, int debug_level_=0, int print_level_=2)
	A constructor of the Settings object.
	~Settings (void)
	A destructor of the Settings object.
void	set_use_winding (const bool &use_winding_)
	Set a flag that defines whether the solver will use the winding number evaluation or just Newton iterations.
void	set_max_part_level (const int &max_part_level_)
	Set the maximum allowed level of the rectangle partition.
void	set_debug_level (const int &debug_level_)
	Set the debug level (determines the amount of internal checks).
void	set_print_level (const int &print_level_)
	Set the print level (determines the amount of details printed).
const bool &	get_use_winding (void) const
	Get a flag that defines whether the solver will use the winding number evaluation or just Newton iterations.
const int &	get_max_part_level (void) const
	Get the maximum allowed level of the rectangle partition.
const int &	get_debug_level (void) const
	Get the debug level (determines the amount of internal checks).
const int &	get_print_level (void) const
	Get the print level (determines the amount of details printed).

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

Detailed Description

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

The class contains settings used by the zeros search algorithm.

Constructor & Destructor Documentation

template<typename T = double>

alg::zersol::Settings< T >::Settings ( bool  use_winding_ = true, int  max_part_level_ = 128, int  debug_level_ = 0, int  print_level_ = 2  )

inline

A constructor of the Settings object.

Parameters

use_winding_	define whether the solver will use the winding number evaluation or just simple Newton iterations
max_part_level_	maximum allowed level of the rectangle partition
debug_level_	debug level (determines the amount of internal checks)
print_level_	print level (determines the amount of details printed)

template<typename T = double>

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

inline

A destructor of the Settings object.

Member Function Documentation

template<typename T = double>

void alg::zersol::Settings< T >::set_use_winding ( const bool &  use_winding_ )

inline

Set a flag that defines whether the solver will use the winding number evaluation or just Newton iterations.

Parameters

use_winding_

flag: true - use the winding number evaluation, false - use the Newton's iterations only

template<typename T = double>

void alg::zersol::Settings< T >::set_max_part_level ( const int &  max_part_level_ )

inline

Set the maximum allowed level of the rectangle partition.

Parameters

max_part_level_

partition level

template<typename T = double>

void alg::zersol::Settings< T >::set_debug_level ( const int &  debug_level_ )

inline

Set the debug level (determines the amount of internal checks).

Parameters

debug_level_

debug level

template<typename T = double>

void alg::zersol::Settings< T >::set_print_level ( const int &  print_level_ )

inline

Set the print level (determines the amount of details printed).

Parameters

print_level_

print level

template<typename T = double>

const bool& alg::zersol::Settings< T >::get_use_winding ( void  ) const

inline

Get a flag that defines whether the solver will use the winding number evaluation or just Newton iterations.

Returns

flag: true - use the winding number evaluation, false - use the Newton's iterations only

template<typename T = double>

const int& alg::zersol::Settings< T >::get_max_part_level ( void  ) const

inline

Get the maximum allowed level of the rectangle partition.

Returns

partition level

template<typename T = double>

const int& alg::zersol::Settings< T >::get_debug_level ( void  ) const

inline

Get the debug level (determines the amount of internal checks).

Returns

debug level

template<typename T = double>

const int& alg::zersol::Settings< T >::get_print_level ( void  ) const

inline

Get the print level (determines the amount of details printed).

Returns

print level

Friends And Related Function Documentation

template<typename T = double>

std::ostream& operator<< ( std::ostream &  output, const Settings< T > &  S  )

friend

An insertion operator to print content of the object.

Parameters

output	output stream for the insertion
S	Settings object to be inserted (printed)

Returns

output stream