Record Class RandomMim.LatentGroupSpec

java.lang.Object

java.lang.Record

edu.cmu.tetrad.graph.RandomMim.LatentGroupSpec

Record Components:

countGroups - how many groups with this configuration; must be >= 1

rank - number of latent factors per group; must be >= 1

childrenPerGroup - number of measured children per latent group; must be >= 1

Enclosing class:

RandomMim

public static record RandomMim.LatentGroupSpec(int countGroups, int rank, int childrenPerGroup)
extends Record

Specification for a block of groups sharing the same rank and number of children per latent.

Constructor Summary

Constructors

Constructor	Description
LatentGroupSpec(int countGroups, int rank, int childrenPerGroup)	Constructs a specification for a block of groups sharing the same rank and number of children per latent.

Method Summary

Modifier and Type	Method	Description
int	childrenPerGroup()	Returns the value of the childrenPerGroup record component.
int	countGroups()	Returns the value of the countGroups record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	rank()	Returns the value of the rank record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LatentGroupSpec

public LatentGroupSpec(int countGroups,
 int rank,
 int childrenPerGroup)

Constructs a specification for a block of groups sharing the same rank and number of children per latent. Validates that all provided parameters meet the required constraints.

Parameters:

countGroups - the number of groups with this configuration; must be >= 1

rank - the number of latent factors per group; must be >= 1

childrenPerGroup - the number of measured children per latent group; must be >= 1

Throws:

IllegalArgumentException - if any parameter value is less than 1

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. All components in this record class 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.

countGroups

public int countGroups()

Returns the value of the countGroups record component.

Returns:

the value of the countGroups record component

rank

public int rank()

Returns the value of the rank record component.

Returns:

the value of the rank record component

childrenPerGroup

public int childrenPerGroup()

Returns the value of the childrenPerGroup record component.

Returns:

the value of the childrenPerGroup record component