Module com.darkcollective.relix.solver

Package com.darkcollective.relix.solver

Record Class LinearProgram.Constraint

java.lang.Object

java.lang.Record

com.darkcollective.relix.solver.LinearProgram.Constraint

Record Components:

coefficients - one coefficient per variable, positionally

relation - how the weighted sum relates to the bound

bound - the right-hand side

Enclosing class:

LinearProgram

public static record LinearProgram.Constraint(double[] coefficients, LinearProgram.Relation relation, double bound)
extends Record

One linear constraint: Σ coefficients[i]·x[i] related to bound.

Constructor Summary

Constructors

Constructor	Description
Constraint(double[] coefficients, LinearProgram.Relation relation, double bound)	Creates an instance of a Constraint record class.

Method Summary

Modifier and Type	Method	Description
double	bound()	Returns the value of the bound record component.
double[]	coefficients()	Returns the value of the coefficients 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.
LinearProgram.Relation	relation()	Returns the value of the relation record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Constraint

public Constraint(double[] coefficients,
 LinearProgram.Relation relation,
 double bound)

Creates an instance of a Constraint record class.

Parameters:

coefficients - the value for the coefficients record component

relation - the value for the relation record component

bound - the value for the bound record component

Method Details

coefficients

public double[] coefficients()

Returns the value of the coefficients record component.

Returns:

the value of the coefficients record component

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 '=='.

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.

relation

public LinearProgram.Relation relation()

Returns the value of the relation record component.

Returns:

the value of the relation record component

bound

public double bound()

Returns the value of the bound record component.

Returns:

the value of the bound record component