ctu.nengoros.comm.rosBackend.encoders.multiTermination

Class AbstractMultiTermination

java.lang.Object

ctu.nengoros.comm.rosBackend.encoders.multiTermination.AbstractMultiTermination

All Implemented Interfaces:

Resettable, MultiTermination, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BasicMultiTermination

public abstract class AbstractMultiTermination
extends java.lang.Object
implements MultiTermination

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	counter
float	DEF_W
protected int	dimensions
protected Integrator	integ
protected DynamicalSystem	lti
static java.lang.String	me
protected java.util.HashMap<java.lang.String,Termination>	myTerminations
protected TimeSeries	myValue
protected java.util.Map<java.lang.String,java.lang.Float[]>	myWeights
protected java.lang.String	name
protected java.util.LinkedList<Termination>	orderedTerminations
protected Node	parent

Constructor Summary

Constructors

Constructor and Description
AbstractMultiTermination(NeuralModule parent, java.lang.String name, Integrator integ, DynamicalSystem lti2)

Method Summary

Methods

Modifier and Type	Method and Description
Termination	addTermination() Add new weighted termination with the default weight (1).
Termination	addTermination(float weight) Specify the weight of this newly created Termination, if the Terminaion is multi-dimensional, weight will be applied on all dimensions.
abstract Termination	addTermination(java.lang.Float[] weights) Specify the weight matrix for this newly created weighted Termination.
protected void	checkDimensions(java.lang.Float[] weights)
protected java.lang.String	generateName() This method generates unique name for my Termination based on the name of MultiTermination.
protected java.lang.Float[]	generateWeights(float weight)
int	getDimension() NUmber of values passed through multiTerminations, the same as dimensions of all child Terminations.
java.lang.String	getName()
Node	getNode() Get parent Node of my all Terminations.
TimeSeries	getOutput() Get output of this MultiTermination
java.util.HashMap<java.lang.String,Termination>	getTerminations()
protected java.lang.Float[]	readWeights(java.lang.String name)
void	reset(boolean randomize)
void	run(float startTime, float endTime) Connect data on all its Terminations, terminations are ran by the NeuralModule to which they are registered (too).
protected abstract void	runAllTerminations(float startTime, float endTime) Runs all its Terminations.
protected abstract void	runCombineValues(float startTime, float endTime) Collects data from its Terminations and sets its own value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

me

public static final java.lang.String me

See Also:

Constant Field Values

orderedTerminations

protected final java.util.LinkedList<Termination> orderedTerminations

myWeights

protected final java.util.Map<java.lang.String,java.lang.Float[]> myWeights

myTerminations

protected final java.util.HashMap<java.lang.String,Termination> myTerminations

counter

protected int counter

name

protected final java.lang.String name

dimensions

protected final int dimensions

parent

protected final Node parent

DEF_W

public final float DEF_W

See Also:

Constant Field Values

myValue

protected TimeSeries myValue

integ

protected final Integrator integ

lti

protected final DynamicalSystem lti

Constructor Detail

AbstractMultiTermination

public AbstractMultiTermination(NeuralModule parent,
                        java.lang.String name,
                        Integrator integ,
                        DynamicalSystem lti2)

Method Detail

getTerminations

public java.util.HashMap<java.lang.String,Termination> getTerminations()

Specified by:

getTerminations in interface MultiTermination

run

public void run(float startTime,
       float endTime)
         throws SimulationException

Connect data on all its Terminations, terminations are ran by the NeuralModule to which they are registered (too).

Specified by:

run in interface MultiTermination

Parameters:

startTime - simulation time at which running starts (s)

endTime - simulation time at which running ends (s)

Throws:

SimulationException - if a problem is encountered while trying to run

reset

public void reset(boolean randomize)

Specified by:

reset in interface Resettable

Parameters:

randomize - True indicates that the object should be reset to a randomly selected initial state (the object must be aware of the distribution from which to draw from). False indicates that the object should be reset to a fixed initial state (which it must also know). Some objects may not support randomization of the initial state, in which case a fixed state will be used in either case.

getName

public java.lang.String getName()

Specified by:

getName in interface MultiTermination

runAllTerminations

protected abstract void runAllTerminations(float startTime,
                      float endTime)
                                    throws SimulationException

Runs all its Terminations.

Parameters:

startTime -

endTime -

Throws:

SimulationException

runCombineValues

protected abstract void runCombineValues(float startTime,
                    float endTime)
                                  throws SimulationException

Collects data from its Terminations and sets its own value

Parameters:

startTime -

endTime -

Throws:

SimulationException

generateName

protected java.lang.String generateName()

This method generates unique name for my Termination based on the name of MultiTermination. For the backwards compatibility, the first Termination is created by default and is named identically as the MultiTermination.

Returns:

name of the Termination. If no Terminations registered so far, return my name.

addTermination

public Termination addTermination(float weight)
                           throws StructuralException

Description copied from interface: MultiTermination

Specify the weight of this newly created Termination, if the Terminaion is multi-dimensional, weight will be applied on all dimensions.

Specified by:

addTermination in interface MultiTermination

Parameters:

weight - the termination can be weighter

Returns:

new weighted Termination with auto-generated name

Throws:

StructuralException

addTermination

public abstract Termination addTermination(java.lang.Float[] weights)
                                    throws StructuralException

Description copied from interface: MultiTermination

Specify the weight matrix for this newly created weighted Termination.

Specified by:

addTermination in interface MultiTermination

Parameters:

weights - weight matrix

Returns:

new weighted Termination with auto-generated name

Throws:

StructuralException

addTermination

public Termination addTermination()
                           throws StructuralException

Description copied from interface: MultiTermination

Add new weighted termination with the default weight (1). The Terminations are named as follows: first Termination is created automatically and corresponds with the name of MultiTermination (backwards compatibility). Following added Terminations are named as follows: "[MultiTermination_name]_0", "[MultiTermination_name]_1", ...

Specified by:

addTermination in interface MultiTermination

Returns:

new Termination with auto-generated name

Throws:

StructuralException

checkDimensions

protected void checkDimensions(java.lang.Float[] weights)
                        throws StructuralException

Throws:

StructuralException

readWeights

protected java.lang.Float[] readWeights(java.lang.String name)
                                 throws SimulationException

Throws:

SimulationException

generateWeights

protected java.lang.Float[] generateWeights(float weight)

getNode

public Node getNode()

Description copied from interface: MultiTermination

Get parent Node of my all Terminations.

Specified by:

getNode in interface MultiTermination

Returns:

getDimension

public int getDimension()

Description copied from interface: MultiTermination

NUmber of values passed through multiTerminations, the same as dimensions of all child Terminations.

Specified by:

getDimension in interface MultiTermination

Returns:

dimensionality of the multi-termination

getOutput

public TimeSeries getOutput()

Description copied from interface: MultiTermination

Get output of this MultiTermination

Specified by:

getOutput in interface MultiTermination

Returns:

TimeSeries representing the actual output