Record Class PortfolioOptimizer.EfficientFrontierPoint

java.lang.Object

java.lang.Record

org.episteme.social.economics.PortfolioOptimizer.EfficientFrontierPoint

Enclosing class:

PortfolioOptimizer

public static record PortfolioOptimizer.EfficientFrontierPoint(Real targetReturn, Real minimumVolatility, Map<String,Real> weights)
extends Record

Constructor Summary

Constructors

Constructor	Description
EfficientFrontierPoint(Real targetReturn, Real minimumVolatility, Map<String,Real> weights)	Creates an instance of a EfficientFrontierPoint record class.

Method Summary

Modifier and Type	Method	Description
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.
Real	minimumVolatility()	Returns the value of the minimumVolatility record component.
Real	targetReturn()	Returns the value of the targetReturn record component.
final String	toString()	Returns a string representation of this record class.
Map<String,Real>	weights()	Returns the value of the weights record component.

Methods inherited from class Object

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

Constructor Details

EfficientFrontierPoint

public EfficientFrontierPoint(Real targetReturn,
 Real minimumVolatility,
 Map<String,Real> weights)

Creates an instance of a EfficientFrontierPoint record class.

Parameters:

targetReturn - the value for the targetReturn record component

minimumVolatility - the value for the minimumVolatility record component

weights - the value for the weights 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. 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.

targetReturn

public Real targetReturn()

Returns the value of the targetReturn record component.

Returns:

the value of the targetReturn record component

minimumVolatility

public Real minimumVolatility()

Returns the value of the minimumVolatility record component.

Returns:

the value of the minimumVolatility record component

weights

public Map<String,Real> weights()

Returns the value of the weights record component.

Returns:

the value of the weights record component