Record Class TradeFlowAnalyzer.GravityModelResult

java.lang.Object
java.lang.Record
org.episteme.social.economics.TradeFlowAnalyzer.GravityModelResult
Enclosing class:
TradeFlowAnalyzer
public static record TradeFlowAnalyzer.GravityModelResult(TradeFlowAnalyzer.Country origin, TradeFlowAnalyzer.Country destination, Real predictedFlow, Real actualFlow, Real residual) extends Record

  • Constructor Details

    • GravityModelResult

      public GravityModelResult(TradeFlowAnalyzer.Country origin, TradeFlowAnalyzer.Country destination, Real predictedFlow, Real actualFlow, Real residual)
      Creates an instance of a GravityModelResult record class.
      Parameters:
      origin - the value for the origin record component
      destination - the value for the destination record component
      predictedFlow - the value for the predictedFlow record component
      actualFlow - the value for the actualFlow record component
      residual - the value for the residual 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.

    • origin

      public TradeFlowAnalyzer.Country origin()
      Returns the value of the origin record component.
      Returns:
      the value of the origin record component

    • destination

      public TradeFlowAnalyzer.Country destination()
      Returns the value of the destination record component.
      Returns:
      the value of the destination record component

    • predictedFlow

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

    • actualFlow

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

    • residual

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