Record Class SegregationModel.GridState

java.lang.Object

java.lang.Record

org.episteme.social.sociology.SegregationModel.GridState

All Implemented Interfaces:

Serializable

Enclosing class:

SegregationModel

public static record SegregationModel.GridState(int step, SegregationModel.AgentType[][] grid, Real segregationIndex, Real happinessRate, int moves)
extends Record
implements Serializable

Represents a snapshot of the grid at a specific simulation step.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GridState(int step, SegregationModel.AgentType[][] grid, Real segregationIndex, Real happinessRate, int moves)	Creates an instance of a GridState record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
SegregationModel.AgentType[][]	grid()	Returns the value of the grid record component.
Real	happinessRate()	Returns the value of the happinessRate record component.
final int	hashCode()	Returns a hash code value for this object.
int	moves()	Returns the value of the moves record component.
Real	segregationIndex()	Returns the value of the segregationIndex record component.
int	step()	Returns the value of the step record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

GridState

public GridState(int step,
 SegregationModel.AgentType[][] grid,
 Real segregationIndex,
 Real happinessRate,
 int moves)

Creates an instance of a GridState record class.

Parameters:

step - the value for the step record component

grid - the value for the grid record component

segregationIndex - the value for the segregationIndex record component

happinessRate - the value for the happinessRate record component

moves - the value for the moves record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

step

public int step()

Returns the value of the step record component.

Returns:

the value of the step record component

grid

public SegregationModel.AgentType[][] grid()

Returns the value of the grid record component.

Returns:

the value of the grid record component

segregationIndex

public Real segregationIndex()

Returns the value of the segregationIndex record component.

Returns:

the value of the segregationIndex record component

happinessRate

public Real happinessRate()

Returns the value of the happinessRate record component.

Returns:

the value of the happinessRate record component

moves

public int moves()

Returns the value of the moves record component.

Returns:

the value of the moves record component