Module io.jenetics.base
Package io.jenetics.util

Record Class DoubleRange

java.lang.Object
java.lang.Record
io.jenetics.util.DoubleRange
Record Components:
min - the minimum value of the range
max - the maximum value of the range
All Implemented Interfaces:
Serializable
public record DoubleRange(double min, double max) extends Record implements Serializable
Double range class.
Since:
3.2
Version:
8.3
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    DoubleRange(double min, double max)
    Create a new DoubleRange object with the given min and max values.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(double value)
    Checks whether the given value is within the range [min, max).
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Optional<DoubleRange>
    intersect(DoubleRange other)
    Return the intersection of this range with the other.
    double
    max()
    Returns the value of the max record component.
    double
    min()
    Returns the value of the min record component.
    static DoubleRange
    of(double min, double max)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Class is a record now, and this factory method will be removed in the next major version.
    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

    • DoubleRange

      public DoubleRange(double min, double max)
      Create a new DoubleRange object with the given min and max values.
      Parameters:
      min - the lower bound of the double range
      max - the upper bound of the double range
      Throws:
      IllegalArgumentException - if min > max or one of the parameters is not finite

  • Method Details

    • contains

      public boolean contains(double value)
      Checks whether the given value is within the range [min, max).
      Parameters:
      value - the value to check
      Returns:
      true if the value is with the range [min, max), false otherwise
      Since:
      8.0

    • intersect

      public Optional<DoubleRange> intersect(DoubleRange other)
      Return the intersection of this range with the other.
      Parameters:
      other - the intersection range or Optional.empty() if there is none
      Returns:
      the range intersection
      Since:
      8.0

    • of

      @Deprecated(since="8.2", forRemoval=true) public static DoubleRange of(double min, double max)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Class is a record now, and this factory method will be removed in the next major version. Use DoubleRange(double, double) instead.
      Create a new DoubleRange object with the given min and max values.
      Parameters:
      min - the lower bound of the double range
      max - the upper bound of the double range
      Returns:
      a new DoubleRange object
      Throws:
      IllegalArgumentException - if min > max

    • toString

      public 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