Package org.opentrafficsim.core.distributions

Record Class FrequencyAndObject<O>

java.lang.Object
java.lang.Record
org.opentrafficsim.core.distributions.FrequencyAndObject<O>
Type Parameters:
O - Type of the object returned by the draw method
Record Components:
frequency - the (not cumulative) frequency (or probability) of the generatingObject
object - an object
public record FrequencyAndObject<O>(double frequency, O object) extends Record
Immutable storage for a frequency (or probability) plus a Generator.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FrequencyAndObject(double frequency, O object)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    frequency()
    Returns the value of the frequency record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    O
    object()
    Returns the value of the object record component.
    final String
    toString()
    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

    • FrequencyAndObject

      public FrequencyAndObject(double frequency, O object)
      Constructor.
      Parameters:
      frequency - the (not cumulative) frequency (or probability) of the generatingObject
      object - an object

  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • frequency

      public double frequency()
      Returns the value of the frequency record component.
      Returns:
      the value of the frequency record component

    • object

      public O object()
      Returns the value of the object record component.
      Returns:
      the value of the object record component