Package lib.util

Record Class Util.Range

java.lang.Object
java.lang.Record
lib.util.Util.Range
Enclosing class:
Util
public static record Util.Range(double min, double max) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Range(double min, double max)
    Creates an instance of a Range record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(double value)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    getCenter()
     
    double
    getRange()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    limitValue(double value)
    Limits a value to the range.
    double
    max()
    Returns the value of the max record component.
    double
    min()
    Returns the value of the min record component.
    double
    scaleValue(double value)
    Scales a value (between -1 and 1) to the range.
    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

    • Range

      public Range(double min, double max)
      Creates an instance of a Range record class.
      Parameters:
      min - the value for the min record component
      max - the value for the max record component

  • Method Details

    • getRange

      public double getRange()

    • contains

      public boolean contains(double value)

    • getCenter

      public double getCenter()

    • scaleValue

      public double scaleValue(double value)
      Scales a value (between -1 and 1) to the range. Example: (new Range(0,6)).scaleValue(0.5) == 4.5
      Parameters:
      value - between -1 and 1 (will be limited to [-1, 1])
      Returns:
      the scaled value

    • limitValue

      public double limitValue(double value)
      Limits a value to the range. Example: (new Range(0,6)).limitValue(7) == 6
      Parameters:
      value - the value to be limited
      Returns:
      the limited value

    • 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.

    • min

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

    • max

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