StateSystem Class Reference

Abstract agent-based state system. More...

Inheritance diagram for StateSystem:

Collaboration diagram for StateSystem:

Public Member Functions
def	__init__
def	run
def	hasConverged
	Define if the system has converged based on the status variables. More...

Static Public Member Functions
def	maxDelta
	Get the maximum deviation between two list of values. More...

Public Attributes
	history
	History of the data. More...
	eps
	Numerical accuracy. More...

Private Attributes
	_maxDifference
	Maximum difference between the two last iterations. More...

Static Private Attributes
	__metaclass__ = ABCMeta

Detailed Description

Abstract agent-based state system.

A state system is a system where the convergence is based on status variables. The system check global status variable referenced in a list of variable reference in data.general['statusVariables']. The personal status variable of StateAgent are also checked.

Constructor & Destructor Documentation

def __init__	(		self,
			maximumIterations = 1000,
			accuracy = 0.0001
	)

Member Function Documentation

def hasConverged

(

self

)

Define if the system has converged based on the status variables.

Returns

None if the system has not converged.

def maxDelta (   v1,   v2  )

static

Get the maximum deviation between two list of values.

Parameters

v1	List of values.
v2	List of values.

Returns

Float.

def run

(

self

)

Member Data Documentation

__metaclass__ = ABCMeta

staticprivate

_maxDifference

private

Maximum difference between the two last iterations.

eps

Numerical accuracy.

history

History of the data.

---

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

• simulator/src/agent/stateSystem.py