MyGainStateInfo< StateType > Class Template Reference

List of all members.

Public Member Functions
string	getId () const
void	setId (string _id)
StateType	getInitialState () const
StateType	getCurrentState () const
StateType	getPreviousState () const
StateType	getState () const
void	setState (StateType newState)
void	initialiseState (StateType state)
bool	hasConverged ()
bool	hasConvergedApproximately (MyNT epsilon=1e-03) const
bool	isClamped () const
void	clamp ()
void	unclamp ()

---

Detailed Description

template<typename StateType>
class MyGainStateInfo< StateType >

templated class that stores various pieces of information relevant to the state of a node.

---

Member Function Documentation

template<typename StateType >

bool MyGainStateInfo< StateType >::hasConverged

(

)

[inline]

Check whether the current state of the node is the same as the previous state of the node.

To check for convergence, it is enough to check whether the collapsed value of the current state equals the collapsed value of the previous state. This statement is certainly true and needed for MyOneVersusAllHopfieldGainAlgo.

template<typename StateType >

bool MyGainStateInfo< StateType >::hasConvergedApproximately

(

MyNT

epsilon = 1e-03

)

const [inline]

Check whether the current state of the node is the same as the previous state of the node.

Parameters:

epsilon,consider

two states to be equal if they differ by less than this parameter.

---

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

• /home/poirel/src/c++/biorithm/gain/gain-state.h