Record Class PortfolioOptimizer.Asset

java.lang.Object
java.lang.Record
org.episteme.social.economics.PortfolioOptimizer.Asset
Enclosing class:
PortfolioOptimizer
public static record PortfolioOptimizer.Asset(String symbol, String name, Real expectedReturn, Real volatility) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Asset(String symbol, String name, Real expectedReturn, Real volatility)
    Creates an instance of a Asset record class.

  • Method Summary

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

    Methods inherited from class Object

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

  • Constructor Details

    • Asset

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

    • symbol

      public String symbol()
      Returns the value of the symbol record component.
      Returns:
      the value of the symbol record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name 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