agi.foundation.propagators

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

Class PropagationStateArray

java.lang.Object

agi.foundation.propagators.PropagationStateArray

All Implemented Interfaces:

IEquatable<PropagationStateArray>, ImmutableValueType, ValueType

public final class PropagationStateArray
extends Object
implements IEquatable<PropagationStateArray>, ImmutableValueType

Provides a means of specifying an indexable object which represents a set of values mapping a subset of the overall state elements. The sub-elements are defined by a set of indices into the overall state.

Constructor Summary

Constructors

Constructor and Description
PropagationStateArray() Initializes a new instance.
PropagationStateArray(double[] state, int[] indices) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(PropagationStateArray left, PropagationStateArray right) Returns true if the two instances are exactly equal.
boolean	equalsType(PropagationStateArray other) Indicates whether another instance of this type is exactly equal to this instance.
double	get(int index) Gets the value of the element at the given sub-state index.
int[]	getIndicesIntoOverallState() Gets the set of indices for each sub-state element which represent the indices into the OverallState (get).
int	getLength() Gets the length of this sub-state.
double[]	getOverallState() Gets the overall state array which this sub-state maps into.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(PropagationStateArray left, PropagationStateArray right) Returns true if the two instances are not exactly equal.
void	set(int index, double value) Sets the value of the element at the given sub-state index.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropagationStateArray

public PropagationStateArray()

Initializes a new instance.

PropagationStateArray

public PropagationStateArray(double[] state,
                             int[] indices)

Initializes a new instance.

Parameters:

state - The overall state array.

indices - The indices specifying the elements of this sub-state.

Method Detail

get

public final double get(int index)

Gets the value of the element at the given sub-state index. The value represents the element in the overall state at

Parameters:

index - The index into this sub-state (not the index into the overall state).

Returns:

The value at the given sub-state index.

set

public final void set(int index,
                      double value)

Sets the value of the element at the given sub-state index. The value represents the element in the overall state at

Parameters:

index - The index into this sub-state (not the index into the overall state).

getLength

public final int getLength()

Gets the length of this sub-state.

getOverallState

public final double[] getOverallState()

Gets the overall state array which this sub-state maps into.

getIndicesIntoOverallState

public final int[] getIndicesIntoOverallState()

Gets the set of indices for each sub-state element which represent the indices into the OverallState (get).

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                PropagationStateArray other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<PropagationStateArray>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public static boolean equals(@Nonnull
                             PropagationStateArray left,
                             @Nonnull
                             PropagationStateArray right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                PropagationStateArray left,
                                @Nonnull
                                PropagationStateArray right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.