Record Class PortfolioOptimizer.Portfolio

java.lang.Object
java.lang.Record
org.episteme.social.economics.PortfolioOptimizer.Portfolio
Enclosing class:
PortfolioOptimizer
public static record PortfolioOptimizer.Portfolio(Map<String,Real> weights, Real expectedReturn, Real volatility, Real sharpeRatio) extends Record

  • Constructor Details

    • Portfolio

      public Portfolio(Map<String,Real> weights, Real expectedReturn, Real volatility, Real sharpeRatio)
      Creates an instance of a Portfolio record class.
      Parameters:
      weights - the value for the weights record component
      expectedReturn - the value for the expectedReturn record component
      volatility - the value for the volatility record component
      sharpeRatio - the value for the sharpeRatio 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.

    • weights

      public Map<String,Real> weights()
      Returns the value of the weights record component.
      Returns:
      the value of the weights record component

    • expectedReturn

      public Real expectedReturn()
      Returns the value of the expectedReturn record component.
      Returns:
      the value of the expectedReturn record component

    • volatility

      public Real volatility()
      Returns the value of the volatility record component.
      Returns:
      the value of the volatility record component

    • sharpeRatio

      public Real sharpeRatio()
      Returns the value of the sharpeRatio record component.
      Returns:
      the value of the sharpeRatio record component