Record Class SensitivityReport

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.solve.SensitivityReport

Record Components:

recommended - the recommended portfolio key

weightRanges - per weighted objective, the weight range that keeps the recommendation

nearest - the closest other frontier option, or null when the frontier has one option

constraints - per constraint, whether removing it would change the recommendation

notes - caveats (incomplete relaxation, narrowed search)

public record SensitivityReport(String recommended, List<SensitivityReport.WeightRange> weightRanges, SensitivityReport.NearestAlternative nearest, List<SensitivityReport.BindingConstraint> constraints, List<String> notes)
extends Record

How firm the recommendation is. Built by SensitivityAnalysis from the solver's own evidence, without searching again.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SensitivityReport.BindingConstraint	Whether a constraint decides the answer.
static final record	SensitivityReport.NearestAlternative	The frontier option nearest the recommendation in normalised-score space.
static final record	SensitivityReport.WeightRange	The range of one objective's share of the total weight over which the recommendation stays the same, the other weights keeping their proportions to each other.

Constructor Summary

Constructors

Constructor	Description
SensitivityReport(String recommended, List<SensitivityReport.WeightRange> weightRanges, SensitivityReport.NearestAlternative nearest, List<SensitivityReport.BindingConstraint> constraints, List<String> notes)	Makes the lists immutable.

Method Summary

Modifier and Type	Method	Description
List<SensitivityReport.BindingConstraint>	constraints()	Returns the value of the constraints 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.
SensitivityReport.NearestAlternative	nearest()	Returns the value of the nearest record component.
List<String>	notes()	Returns the value of the notes record component.
String	recommended()	Returns the value of the recommended record component.
final String	toString()	Returns a string representation of this record class.
List<SensitivityReport.WeightRange>	weightRanges()	Returns the value of the weightRanges record component.

Methods inherited from class Object

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

Constructor Details

SensitivityReport

public SensitivityReport(String recommended,
 List<SensitivityReport.WeightRange> weightRanges,
 SensitivityReport.NearestAlternative nearest,
 List<SensitivityReport.BindingConstraint> constraints,
 List<String> notes)

Makes the lists immutable.

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 Objects::equals(Object,Object).

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.

recommended

public String recommended()

Returns the value of the recommended record component.

Returns:

the value of the recommended record component

weightRanges

public List<SensitivityReport.WeightRange> weightRanges()

Returns the value of the weightRanges record component.

Returns:

the value of the weightRanges record component

nearest

public SensitivityReport.NearestAlternative nearest()

Returns the value of the nearest record component.

Returns:

the value of the nearest record component

constraints

public List<SensitivityReport.BindingConstraint> constraints()

Returns the value of the constraints record component.

Returns:

the value of the constraints record component

notes

public List<String> notes()

Returns the value of the notes record component.

Returns:

the value of the notes record component