Record Class InitialTemperature

java.lang.Object
java.lang.Record
edu.cnu.mdi.sim.simanneal.InitialTemperature
Record Components:
T0 - positive absolute initial temperature
energyMedian - median energy in the heuristic's sample
energyMad - median absolute deviation of sampled energies
samples - number of solutions sampled

public record InitialTemperature(double T0, double energyMedian, double energyMad, int samples) extends Record
Result of estimating the initial annealing temperature.
  • Constructor Summary

    Constructors
    Constructor
    Description
    InitialTemperature(double T0, double energyMedian, double energyMad, int samples)
    Creates an instance of a InitialTemperature record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    double
    Returns the value of the energyMad record component.
    double
    Returns the value of the energyMedian record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    int
    Returns the value of the samples record component.
    double
    T0()
    Returns the value of the T0 record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • InitialTemperature

      public InitialTemperature(double T0, double energyMedian, double energyMad, int samples)
      Creates an instance of a InitialTemperature record class.
      Parameters:
      T0 - the value for the T0 record component
      energyMedian - the value for the energyMedian record component
      energyMad - the value for the energyMad record component
      samples - the value for the samples 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 '=='.
      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.
    • T0

      public double T0()
      Returns the value of the T0 record component.
      Returns:
      the value of the T0 record component
    • energyMedian

      public double energyMedian()
      Returns the value of the energyMedian record component.
      Returns:
      the value of the energyMedian record component
    • energyMad

      public double energyMad()
      Returns the value of the energyMad record component.
      Returns:
      the value of the energyMad record component
    • samples

      public int samples()
      Returns the value of the samples record component.
      Returns:
      the value of the samples record component