Class Dimensionless

All Implemented Interfaces:
Serializable, Comparable<Dimensionless>, Additive<Dimensionless>, Scalable<Dimensionless>, Value<Dimensionless>

public class Dimensionless extends Quantity<Dimensionless>
Dimensionless quantity.

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:
Alexander Verbraeck
See Also:
  • Field Details

    • ZERO

      public static final Dimensionless ZERO
      Constant with value zero.
    • ONE

      public static final Dimensionless ONE
      Constant with value one.
    • NaN

      public static final Dimensionless NaN
      Constant with value NaN.
    • POSITIVE_INFINITY

      public static final Dimensionless POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.
    • NEGATIVE_INFINITY

      public static final Dimensionless NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.
    • POS_MAXVALUE

      public static final Dimensionless POS_MAXVALUE
      Constant with value MAX_VALUE.
    • NEG_MAXVALUE

      public static final Dimensionless NEG_MAXVALUE
      Constant with value -MAX_VALUE.
  • Constructor Details

    • Dimensionless

      public Dimensionless(double value, Unitless displayUnit, boolean useSi)
      Instantiate a Dimensionless quantity with an SI or base value and a display unit.
      Parameters:
      value - the quantity value expressed in the SI or base unit
      displayUnit - the display unit to use
      useSi - use SI value when true, use value in unit when false
    • Dimensionless

      public Dimensionless(double valueInUnit, Unitless unit)
      Instantiate a Dimensionless quantity expressed in the given unit.
      Parameters:
      valueInUnit - the quantity value expressed in the given unit
      unit - the unit of the value, also acts as the display unit
  • Method Details

    • ofSi

      public static Dimensionless ofSi(double si)
      Return a Dimensionless instance based on an SI value.
      Parameters:
      si - the si value
      Returns:
      the Dimensionless instance based on an SI value
    • ofSi

      public static Dimensionless ofSi(double siValue, Unitless displayUnit)
      Instantiate a Dimensionless quantity with an SI or base value and a display unit.
      Parameters:
      siValue - the quantity value expressed in the SI or base unit
      displayUnit - the display unit to use
      Returns:
      the Dimensionless instance based on an SI value with the given display unit
    • instantiateSi

      public Dimensionless instantiateSi(double siValue, UnitInterface<Dimensionless> displayUnit)
      Description copied from class: Quantity
      Instantiate a quantity with an SI or base value, and a display unit.
      Specified by:
      instantiateSi in class Quantity<Dimensionless>
      Parameters:
      siValue - the value expressed in the base (SI) unit
      displayUnit - the display unit to use for the quantity
      Returns:
      a quantity with the given SI or base value, and the given display unit
    • valueOf

      public static Dimensionless valueOf(String text)
      Returns a Dimensionless representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
      Parameters:
      text - the textual representation to parse into a Dimensionless
      Returns:
      the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the text cannot be parsed
      NullPointerException - when the text argument is null
    • of

      public static Dimensionless of(double valueInUnit, Unitless unit)
      Returns a Dimensionless based on a value expressed in the unit.
      Parameters:
      valueInUnit - the value, expressed in the given unit
      unit - the unit of the value, also acts as the display unit
      Returns:
      ab Dimensionless representation of the value in its unit
    • of

      public static Dimensionless of(double valueInUnit, String unitString)
      Returns a Dimensionless based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      valueInUnit - the value, expressed in the unit as given by unitString
      unitString - the textual representation of the unit
      Returns:
      the Scalar representation of the value in its unit
      Throws:
      IllegalArgumentException - when the unit cannot be parsed or is incorrect
      NullPointerException - when the unitString argument is null
    • getDisplayUnit

      public Unitless getDisplayUnit()
      Description copied from interface: Value
      Retrieve the unit of this Value.
      Specified by:
      getDisplayUnit in interface Value<Dimensionless>
      Overrides:
      getDisplayUnit in class Quantity<Dimensionless>
      Returns:
      the unit of this Value
    • divide

      public Dimensionless divide(Dimensionless v)
      Calculate the division of Dimensionless and Dimensionless, which results in a Dimensionless quantity.
      Parameters:
      v - quantity
      Returns:
      quantity as a division of Dimensionless and Dimensionless
    • divide

      public LinearObjectDensity divide(Length v)
      Calculate the division of Dimensionless and Length, which results in a LinearObjectDensity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Dimensionless and Length
    • divide

      public Length divide(LinearObjectDensity v)
      Calculate the division of Dimensionless and LinearObjectDensity, which results in a Length scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Dimensionless and LinearObjectDensity
    • divide

      public Frequency divide(Duration v)
      Calculate the division of Dimensionless and Duration, which results in a Frequency scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Dimensionless and Duration
    • divide

      public Duration divide(Frequency v)
      Calculate the division of Dimensionless and Frequency, which results in a Duration scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Dimensionless and Frequency
    • divide

      Calculate the division of Dimensionless and ElectricalConductance, which results in a ElectricalResistance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Dimensionless and ElectricalConductance
    • divide

      Calculate the division of Dimensionless and ElectricalResistance, which results in a ElectricalConductance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of Dimensionless and ElectricalResistance
    • reciprocal

      public Dimensionless reciprocal()
      Description copied from class: Quantity
      Return the reciprocal of this quantity (1/q).
      Overrides:
      reciprocal in class Quantity<Dimensionless>
      Returns:
      the reciprocal of this quantity, with the correct SI units