agi.foundation.numericalmethods

(agi.foundation.core-2024r3.jar)

Class StepSizeInformation

java.lang.Object

agi.foundation.numericalmethods.StepSizeInformation

All Implemented Interfaces:

Enumeration

public class StepSizeInformation
extends Object
implements Enumeration

Indicates the behavior of the size of an integration step produced by an integrator.

Field Summary

Fields

Modifier and Type	Field and Description
static StepSizeInformation	DECREASED The step size was decreased by the integrator while adapting it.
static StepSizeInformation	INCREASED The step size was increased by the integrator while adapting it.
static StepSizeInformation	UNCHANGED The step size was unchanged by the integrator
static StepSizeInformation	USED_MAXIMUM The step size was bounded by the maximum step size.
static StepSizeInformation	USED_MINIMUM The step size was bounded by the minimum step size.

Method Summary

Modifier and Type	Method and Description
StepSizeInformation	add(StepSizeInformation other) Add the specified value to the current set and return the result.
boolean	contains(StepSizeInformation other) Determines whether the specified value is present in the current set.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
static StepSizeInformation	getDefault() Get the value that is considered to be the default.
static StepSizeInformation	getFromValue(int value) Get the set of values that are associated with the given numeric value.
int	getValue() Get the numeric value associated with this value.
int	hashCode() Returns a hash code value for the object.
static StepSizeInformation	of(StepSizeInformation... enums) Create a new value built by combining the specified values.
StepSizeInformation	remove(StepSizeInformation other) Remove the specified value from the current set and return the result.
String	toString() Returns a string representation of the object.
static StepSizeInformation[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Object

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

Field Detail

UNCHANGED

@Nonnull
public static final StepSizeInformation UNCHANGED

The step size was unchanged by the integrator

INCREASED

@Nonnull
public static final StepSizeInformation INCREASED

The step size was increased by the integrator while adapting it.

DECREASED

@Nonnull
public static final StepSizeInformation DECREASED

The step size was decreased by the integrator while adapting it.

USED_MAXIMUM

@Nonnull
public static final StepSizeInformation USED_MAXIMUM

The step size was bounded by the maximum step size.

USED_MINIMUM

@Nonnull
public static final StepSizeInformation USED_MINIMUM

The step size was bounded by the minimum step size.

Method Detail

of

@Nonnull
public static StepSizeInformation of(@Nonnull
                                               StepSizeInformation... enums)

Create a new value built by combining the specified values.

Parameters:

enums - the values that the new value will contain.

Returns:

A value that is the combination of the specified values.

add

@Nonnull
public StepSizeInformation add(@Nonnull
                                         StepSizeInformation other)

Add the specified value to the current set and return the result.

Parameters:

other - the new value to be added into the current set.

Returns:

A value that is the combination of the current set and the specified value.

remove

@Nonnull
public StepSizeInformation remove(@Nonnull
                                            StepSizeInformation other)

Remove the specified value from the current set and return the result.

Parameters:

other - the new value to be removed from the current set.

Returns:

A value that is the current set without the specified value.

contains

public boolean contains(@Nonnull
                        StepSizeInformation other)

Determines whether the specified value is present in the current set.

Parameters:

other - the value to be checked against the current set.

Returns:

True if the specified value is present in the current set, false otherwise.

getValue

public int getValue()

Get the numeric value associated with this value.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static StepSizeInformation getFromValue(int value)

Get the set of values that are associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The set of values associated with the numeric value.

values

@Nonnull
public static StepSizeInformation[] values()

Returns an array containing the constants of this enum type, in the order they're declared.

Returns:

The constants of this enum type.

getDefault

@Nonnull
public static StepSizeInformation getDefault()

Get the value that is considered to be the default.

Returns:

The default value.

toString

public String toString()

Description copied from class: java.lang.Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.

equals

public boolean equals(Object o)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

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