The FixedNumber class handles converger test to indicate if the iteration converges. More...

#include <FixedNumber.h>

Inheritance diagram for FixedNumber:

Collaboration diagram for FixedNumber:

Public Member Functions
	FixedNumber (unsigned=0, unsigned=7, bool=false)
	the complete constructor.

unique_ptr< Converger >	unique_copy () override

bool	is_converged (unsigned) override

Public Member Functions inherited from Converger
	Converger (unsigned=0, double=1E-8, unsigned=10, bool=false)
	the complete constructor.

virtual int	initialize ()

void	set_tolerance (double)
	method to set `tolerance`.

double	get_tolerance () const
	method to return `tolerance`.

void	set_max_iteration (unsigned)

unsigned	get_max_iteration () const

void	set_domain (const std::weak_ptr< DomainBase > &)
	method to set `DomainBase`.

const std::weak_ptr< DomainBase > &	get_domain () const
	method to return `DomainBase`.

virtual void	set_error (double)
	method to set `error`.

double	get_error () const
	method to return `error`.

virtual void	set_conv_flag (bool)
	method to set `conv_flag`.

bool	get_conv_flag () const
	method to return `conv_flag`.

Public Member Functions inherited from CopyableTag
	CopyableTag (const CopyableTag &)=default

	CopyableTag (CopyableTag &&)=default

CopyableTag &	operator= (const CopyableTag &)=delete

CopyableTag &	operator= (CopyableTag &&)=delete

	~CopyableTag () override=default

	Tag (unsigned=0)

	Tag (const Tag &)=default

	Tag (Tag &&) noexcept=default

Public Member Functions inherited from Tag
	Tag (unsigned=0)

	Tag (const Tag &)=default

	Tag (Tag &&) noexcept=default

Tag &	operator= (const Tag &)=delete

Tag &	operator= (Tag &&)=delete

virtual	~Tag ()=default

void	set_tag (unsigned) const

unsigned	get_tag () const

void	enable ()

void	disable ()

void	guard ()

void	unguard ()

bool	is_active () const

bool	is_guarded () const

virtual void	print ()

Additional Inherited Members
Protected Member Functions inherited from Converger
vec	get_residual () const

bool	is_print () const
	method to return `print_flag`.

Detailed Description

The FixedNumber class handles converger test to indicate if the iteration converges.

Author: tlc

Date: 27/03/2019

Version: 0.1.0

Constructor & Destructor Documentation

◆ FixedNumber()

FixedNumber::FixedNumber	(	unsigned	T = `0`,
		unsigned	M = `7`,
		bool	P = `false`
	)

explicit

the complete constructor.

Parameters

T	`unique_tag`
M	`max_iteration`
P	`print_flag`

Member Function Documentation

◆ is_converged()

bool FixedNumber::is_converged ( unsigned counter )

overridevirtual

Implements Converger.

Here is the call graph for this function:

◆ unique_copy()

unique_ptr< Converger > FixedNumber::unique_copy ( )