agi.foundation.propagators.advanced

(agi.foundation.models-2024r1.jar)

Class AuxiliaryStateElement

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.propagators.advanced.AuxiliaryStateElement

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

AuxiliaryStateScalar, AuxiliaryStateVector

public abstract class AuxiliaryStateElement
extends DefinitionalObject

Represents a set of variables which are computed and stored in the propagation output but are not integrated with the state.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuxiliaryStateElement() Initializes a new instance.
protected	AuxiliaryStateElement(AuxiliaryStateElement existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(AuxiliaryStateElement other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract AuxiliaryStateElementConverter	getConverter(int[] auxiliaryIndices) Gets an instance of an output type which can convert the output of propagation back into the native type of this auxiliary state element.
abstract int	getDimension() Gets the number of parameters (per Order (get / set)) within this element.
abstract AuxiliaryStateElementEvaluator	getEvaluator(EvaluatorGroup group, int[] auxiliaryIndices) Gets an evaluator which can compute the auxiliary variables based on the current time and any "integrated" definitional objects taken from PropagationStateElements which are updated during integration.
String	getIdentification() Gets the string identifying this instance in the overall output.
abstract int	getOrder() Gets the order of this auxiliary state.
void	setIdentification(String value) Sets the string identifying this instance in the overall output.
abstract void	setOrder(int value) Sets the order of this auxiliary state.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

AuxiliaryStateElement

protected AuxiliaryStateElement()

Initializes a new instance.

AuxiliaryStateElement

protected AuxiliaryStateElement(@Nonnull
                                AuxiliaryStateElement existingInstance,
                                @Nonnull
                                CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(AuxiliaryStateElement other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the AuxiliaryStateElement.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getIdentification

public final String getIdentification()

Gets the string identifying this instance in the overall output.

setIdentification

public final void setIdentification(String value)

Sets the string identifying this instance in the overall output.

getDimension

public abstract int getDimension()

Gets the number of parameters (per Order (get / set)) within this element.

getOrder

public abstract int getOrder()

Gets the order of this auxiliary state.

setOrder

public abstract void setOrder(int value)

Sets the order of this auxiliary state.

getConverter

@Nonnull
public abstract AuxiliaryStateElementConverter getConverter(@Nonnull
                                                                      int[] auxiliaryIndices)

Gets an instance of an output type which can convert the output of propagation back into the native type of this auxiliary state element.

Parameters:

auxiliaryIndices - The set of indices corresponding to the location of each value of this auxiliary state element in the overall auxiliary state.

Returns:

The converter for this output.

getEvaluator

@Nonnull
public abstract AuxiliaryStateElementEvaluator getEvaluator(@Nonnull
                                                                      EvaluatorGroup group,
                                                                      int[] auxiliaryIndices)

Gets an evaluator which can compute the auxiliary variables based on the current time and any "integrated" definitional objects taken from PropagationStateElements which are updated during integration.

Parameters:

group - The evaluator group in which to construct the evaluator.

auxiliaryIndices - The set of indices corresponding to the location of each value of this auxiliary state element in the overall auxiliary state.

Returns:

An evaluator which computes the auxiliary variables for this element.

Throws:

ArgumentNullException - Thrown when group is null.