#include <ginkgo/core/stop/criterion.hpp>

Inheritance diagram for gko::stop::Criterion:

Classes
class	Updater

Public Member Functions
Updater	update ()

bool	check (uint8 stopping_id, bool set_finalized, array< stopping_status > stop_status, bool one_changed, const Updater &updater)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Criterion >
std::unique_ptr< Criterion >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Criterion >	create_default () const

std::unique_ptr< Criterion >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Criterion >	clone () const

Criterion *	copy_from (const PolymorphicObject *other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Criterion > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Criterion > *	copy_from (const std::unique_ptr< Derived > &other)

Criterion *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

Criterion *	move_from (ptr_param< PolymorphicObject > other)

Criterion *	clear ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (std::unique_ptr< Derived, Deleter > &&other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (const std::unique_ptr< Derived, Deleter > &other)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Protected Member Functions
virtual bool	check_impl (uint8 stopping_id, bool set_finalized, array< stopping_status > stop_status, bool one_changed, const Updater &updater)=0

void	set_all_statuses (uint8 stopping_id, bool set_finalized, array< stopping_status > *stop_status)

	Criterion (std::shared_ptr< const gko::Executor > exec)

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

virtual std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const =0

virtual PolymorphicObject *	copy_from_impl (const PolymorphicObject *other)=0

virtual PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other)=0

virtual PolymorphicObject *	move_from_impl (PolymorphicObject *other)=0

virtual PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other)=0

virtual PolymorphicObject *	clear_impl ()=0

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

The Criterion class is a base class for all stopping criteria. It contains a factory to instantiate criteria. It is up to each specific stopping criterion to decide what to do with the data that is passed to it.

Note that depending on the criterion, convergence may not have happened after stopping.

Member Function Documentation

◆ check()

bool gko::stop::Criterion::check	(	uint8	stopping_id,
		bool	set_finalized,
		array< stopping_status > *	stop_status,
		bool *	one_changed,
		const Updater &	updater
	)

inline

This checks whether convergence was reached for a certain criterion. The actual implantation of the criterion goes here.

Parameters

stopping_id	id of the stopping criterion
set_finalized	Controls if the current version should count as finalized or not
stop_status	status of the stopping criterion
one_changed	indicates if the status of a vector has changed
updater	the Updater object containing all the information

Returns: whether convergence was completely reached

References check_impl().

Referenced by gko::stop::Criterion::Updater::check().

◆ check_impl()

virtual bool gko::stop::Criterion::check_impl	(	uint8	stopping_id,
		bool	set_finalized,
		array< stopping_status > *	stop_status,
		bool *	one_changed,
		const Updater &	updater
	)

protectedpure virtual

Implementers of Criterion should override this function instead of check(uint8, bool, array<stopping_status>*, bool*, const Updater&).

This checks whether convergence was reached for a certain criterion. The actual implantation of the criterion goes here.

Parameters

stopping_id	id of the stopping criterion
set_finalized	Controls if the current version should count as finalized or not
stop_status	status of the stopping criterion
one_changed	indicates if the status of a vector has changed
updater	the Updater object containing all the information

Returns: whether convergence was completely reached

Referenced by check().

◆ set_all_statuses()

void gko::stop::Criterion::set_all_statuses	(	uint8	stopping_id,
		bool	set_finalized,
		array< stopping_status > *	stop_status
	)

protected

This is a helper function which properly sets all elements of the stopping_status to converged. This is used in stopping criteria such as Time or Iteration.

Parameters

stopping_id	id of the stopping criterion
set_finalized	Controls if the current version should count as finalized or not
stop_status	status of the stopping criterion

◆ update()

Updater gko::stop::Criterion::update ( )

inline

Returns the updater object

Returns: the updater object

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

ginkgo/core/stop/criterion.hpp

Criterion Class Reference

Criterion Class Reference#

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ check()

◆ check_impl()

◆ set_all_statuses()

◆ update()