The class Criterion is the base class for all stopping criterions that we can use on a Solver. More...

#include <Criterion.hpp>

Inheritance diagram for lama::Criterion:

Public Types
enum	BooleanOperator { AND, OR }
	Defines the operators which can be used to connect Criterions with. More...
Public Member Functions
	Criterion ()
	Creates a Criterion which evaluates to true.
	Criterion (const bool boolean)
	Creates a Criterion which evaluates to the passed boolean.
	Criterion (const Criterion &other)
	Creates a copy of the passed boolean condition.
	Criterion (const CriterionPtr other, const bool modifier)
	Creates a copy of the passed Criterion, which is altered by the passed modifier.
	Criterion (const CriterionPtr leftChild, const CriterionPtr rightChild, BooleanOperator operation)
virtual	~Criterion ()
	Destroys this Criterion.
virtual bool	isSatisfied (const IterativeSolver &solver)
	Checks if this Criterion is true for the state of the passed solver.
const CriterionPtr	getLeftChild () const
const CriterionPtr	getRightChild () const
BooleanOperator	getOperation () const
void	setLeftChild (const CriterionPtr leftChild)
void	setRightChild (const CriterionPtr rightChild)
void	setOperation (const BooleanOperator operation)
bool	hasLeftChild () const
	Returns true if the boolean condition has a left child Do not use getLeftChild() to compare pointers.
bool	hasRightChild () const
	Returns true if the boolean condition has a right child Do not use getRightChild() to compare pointers.
Criterion &	operator= (const Criterion &other)
virtual void	writeAt (std::ostream &stream) const
	Writes some Information about this to the passed stream.
Protected Member Functions
	LAMA_LOG_DECL_STATIC_LOGGER (logger)
Private Attributes
CriterionPtr	mLeftChild
CriterionPtr	mRightChild
BooleanOperator	mOperation
const bool	mModifier

Detailed Description

The class Criterion is the base class for all stopping criterions that we can use on a Solver.

Criterion can be composed with the logical operators &&, ||, and !.

Member Enumeration Documentation

enum lama::Criterion::BooleanOperator

Defines the operators which can be used to connect Criterions with.

Enumerator:

AND	stands for logical and composition
OR	stands for logical or composition

Constructor & Destructor Documentation

lama::Criterion::Criterion ( )

Creates a Criterion which evaluates to true.

lama::Criterion::Criterion ( const bool boolean )

Creates a Criterion which evaluates to the passed boolean.

Parameters:

[in] boolean the boolean to set the result of this boolean condition to.

lama::Criterion::Criterion ( const Criterion & other )

Creates a copy of the passed boolean condition.

Parameters:

[in] other the boolean condition to copy.

lama::Criterion::Criterion	(	const CriterionPtr	other,
		const bool	modifier
	)

Creates a copy of the passed Criterion, which is altered by the passed modifier.

Creates a copy of the passed Criterion, which is altered by the passed modifier. The new Criterion behaves like

     other.isSatisfied() != modifier

which is equivalent to other.isSatisfied() XOR modifier.

Parameters:

[in]	other	the boolean condition to take a altered copy from
[in]	modifier	the bool value to modify the new Criterion with.

lama::Criterion::Criterion	(	const CriterionPtr	leftChild,
		const CriterionPtr	rightChild,
		BooleanOperator	operation
	)

Parameters:

	Creates	a new Criterion which the logical composition of the passed Criterions.
[in]	leftChild	the left operand of the composition
[in]	rightChild	the right operand of the composition
[in]	operation	the logical operation to connect leftChild and rightChild with.