Package org.djunits.value.vdouble.scalar

Class Dimensionless

java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRel<DimensionlessUnit,Dimensionless>
org.djunits.value.vdouble.scalar.Dimensionless
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Dimensionless>, DimensionlessFunctions<DimensionlessUnit,Dimensionless>, Relative<DimensionlessUnit,Dimensionless>, Value<DimensionlessUnit,Dimensionless>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2025-09-06T15:16:28.380798Z") public class Dimensionless extends DoubleScalarRel<DimensionlessUnit,Dimensionless> implements DimensionlessFunctions<DimensionlessUnit,Dimensionless>
Easy access methods for the Dimensionless DoubleScalar, which is relative by definition.

Copyright (c) 2013-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:
Alexander Verbraeck, Peter Knoppers
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, DimensionlessUnit unit)
      Construct Dimensionless scalar with a unit.
      Parameters:
      value - the double value, expressed in the given unit
      unit - unit for the double value

    • Dimensionless

      public Dimensionless(Dimensionless value)
      Construct Dimensionless scalar.
      Parameters:
      value - Scalar from which to construct this instance

  • Method Details

    • instantiateRel

      public final Dimensionless instantiateRel(double value, DimensionlessUnit unit)
      Description copied from class: DoubleScalarRel
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class DoubleScalarRel<DimensionlessUnit,Dimensionless>
      Parameters:
      value - the double value
      unit - the unit
      Returns:
      R a new relative instance of the DoubleScalar of the right type

    • ofSI

      public static final Dimensionless ofSI(double value)
      Construct Dimensionless scalar based on an SI value.
      Parameters:
      value - the double value in SI units
      Returns:
      the new scalar with the SI value

    • interpolate

      public static Dimensionless interpolate(Dimensionless zero, Dimensionless one, double ratio)
      Interpolate between two values. Note that the first value does not have to be smaller than the second.
      Parameters:
      zero - the value at a ratio of zero
      one - the value at a ratio of one
      ratio - the ratio between 0 and 1, inclusive
      Returns:
      a Dimensionless at the given ratio between 0 and 1

    • max

      public static Dimensionless max(Dimensionless r1, Dimensionless r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      Returns:
      the maximum value of two relative scalars

    • max

      public static Dimensionless max(Dimensionless r1, Dimensionless r2, Dimensionless... rn)
      Return the maximum value of more than two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      rn - the other scalars
      Returns:
      the maximum value of more than two relative scalars

    • min

      public static Dimensionless min(Dimensionless r1, Dimensionless r2)
      Return the minimum value of two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      Returns:
      the minimum value of two relative scalars

    • min

      public static Dimensionless min(Dimensionless r1, Dimensionless r2, Dimensionless... rn)
      Return the minimum value of more than two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      rn - the other scalars
      Returns:
      the minimum value of more than two relative scalars

    • 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 value, String unitString)
      Returns a Dimensionless based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      value - the value to use
      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

    • toStringSIPrefixed

      public String toStringSIPrefixed(int smallestPower, int biggestPower)
      Description copied from class: DoubleScalar
      Format this DoubleScalar in SI unit using prefixes when possible and within the specified size range. If the value is too small or too large, e-notation and the plain SI unit are used.
      Overrides:
      toStringSIPrefixed in class DoubleScalar<DimensionlessUnit,Dimensionless>
      Parameters:
      smallestPower - the smallest exponent value that will be written using an SI prefix
      biggestPower - the largest exponent value that will be written using an SI prefix
      Returns:
      formatted value of this DoubleScalar

    • acos

      public final Dimensionless acos()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
      Specified by:
      acos in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • asin

      public final Dimensionless asin()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
      Specified by:
      asin in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • atan

      public final Dimensionless atan()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
      Specified by:
      atan in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • cbrt

      public final Dimensionless cbrt()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the(ir) cube root.
      Specified by:
      cbrt in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • cos

      public final Dimensionless cos()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the trigonometric cosine of the value(s).
      Specified by:
      cos in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • cosh

      public final Dimensionless cosh()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the hyperbolic cosine of the value(s).
      Specified by:
      cosh in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • exp

      public final Dimensionless exp()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to Euler's number e raised to the power of the value(s).
      Specified by:
      exp in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • expm1

      public final Dimensionless expm1()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
      Specified by:
      expm1 in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • log

      public final Dimensionless log()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the natural logarithm (base e) of the value(s).
      Specified by:
      log in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • log10

      public final Dimensionless log10()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the base 10 logarithm of the value(s).
      Specified by:
      log10 in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • log1p

      public final Dimensionless log1p()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
      Specified by:
      log1p in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • pow

      public final Dimensionless pow(double x)
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the value(s) raised to the power of the argument.
      Specified by:
      pow in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Parameters:
      x - the value to use as the power
      Returns:
      the modified T

    • signum

      public final Dimensionless signum()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
      Specified by:
      signum in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • sin

      public final Dimensionless sin()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the trigonometric sine of the value(s).
      Specified by:
      sin in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • sinh

      public final Dimensionless sinh()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the hyperbolic sine of the value(s).
      Specified by:
      sinh in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • sqrt

      public final Dimensionless sqrt()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the correctly rounded positive square root of the value(s).
      Specified by:
      sqrt in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • tan

      public final Dimensionless tan()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the trigonometric tangent of the value(s).
      Specified by:
      tan in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • tanh

      public final Dimensionless tanh()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the hyperbolic tangent of the value(s).
      Specified by:
      tanh in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • inv

      public final Dimensionless inv()
      Description copied from interface: DimensionlessFunctions
      Set the value(s) to the complement (1.0/x) of the value(s).
      Specified by:
      inv in interface DimensionlessFunctions<DimensionlessUnit,Dimensionless>
      Returns:
      the modified T

    • divide

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

    • times

      public final AbsorbedDose times(AbsorbedDose v)
      Calculate the multiplication of Dimensionless and AbsorbedDose, which results in a AbsorbedDose scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and AbsorbedDose

    • times

      public final Acceleration times(Acceleration v)
      Calculate the multiplication of Dimensionless and Acceleration, which results in a Acceleration scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Acceleration

    • times

      public final AmountOfSubstance times(AmountOfSubstance v)
      Calculate the multiplication of Dimensionless and AmountOfSubstance, which results in a AmountOfSubstance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and AmountOfSubstance

    • times

      public final Angle times(Angle v)
      Calculate the multiplication of Dimensionless and Angle, which results in a Angle scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Angle

    • times

      public final SolidAngle times(SolidAngle v)
      Calculate the multiplication of Dimensionless and SolidAngle, which results in a SolidAngle scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and SolidAngle

    • times

      public final Area times(Area v)
      Calculate the multiplication of Dimensionless and Area, which results in a Area scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Area

    • times

      public final CatalyticActivity times(CatalyticActivity v)
      Calculate the multiplication of Dimensionless and CatalyticActivity, which results in a CatalyticActivity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and CatalyticActivity

    • times

      public final Density times(Density v)
      Calculate the multiplication of Dimensionless and Density, which results in a Density scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Density

    • times

      public final Dimensionless times(Dimensionless v)
      Calculate the multiplication of Dimensionless and Dimensionless, which results in a Dimensionless scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Dimensionless

    • times

      public final ElectricalCapacitance times(ElectricalCapacitance v)
      Calculate the multiplication of Dimensionless and ElectricalCapacitance, which results in a ElectricalCapacitance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalCapacitance

    • times

      public final ElectricalCharge times(ElectricalCharge v)
      Calculate the multiplication of Dimensionless and ElectricalCharge, which results in a ElectricalCharge scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalCharge

    • times

      public final ElectricalConductance times(ElectricalConductance v)
      Calculate the multiplication of Dimensionless and ElectricalConductance, which results in a ElectricalConductance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalConductance

    • times

      public final ElectricalCurrent times(ElectricalCurrent v)
      Calculate the multiplication of Dimensionless and ElectricalCurrent, which results in a ElectricalCurrent scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalCurrent

    • times

      public final ElectricalInductance times(ElectricalInductance v)
      Calculate the multiplication of Dimensionless and ElectricalInductance, which results in a ElectricalInductance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalInductance

    • times

      public final ElectricalPotential times(ElectricalPotential v)
      Calculate the multiplication of Dimensionless and ElectricalPotential, which results in a ElectricalPotential scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalPotential

    • times

      public final ElectricalResistance times(ElectricalResistance v)
      Calculate the multiplication of Dimensionless and ElectricalResistance, which results in a ElectricalResistance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and ElectricalResistance

    • times

      public final Energy times(Energy v)
      Calculate the multiplication of Dimensionless and Energy, which results in a Energy scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Energy

    • times

      public final EquivalentDose times(EquivalentDose v)
      Calculate the multiplication of Dimensionless and EquivalentDose, which results in a EquivalentDose scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and EquivalentDose

    • times

      public final FlowMass times(FlowMass v)
      Calculate the multiplication of Dimensionless and FlowMass, which results in a FlowMass scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and FlowMass

    • times

      public final FlowVolume times(FlowVolume v)
      Calculate the multiplication of Dimensionless and FlowVolume, which results in a FlowVolume scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and FlowVolume

    • times

      public final Force times(Force v)
      Calculate the multiplication of Dimensionless and Force, which results in a Force scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Force

    • times

      public final Frequency times(Frequency v)
      Calculate the multiplication of Dimensionless and Frequency, which results in a Frequency scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Frequency

    • times

      public final Illuminance times(Illuminance v)
      Calculate the multiplication of Dimensionless and Illuminance, which results in a Illuminance scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Illuminance

    • times

      public final Length times(Length v)
      Calculate the multiplication of Dimensionless and Length, which results in a Length scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Length

    • times

      public final LinearDensity times(LinearDensity v)
      Calculate the multiplication of Dimensionless and LinearDensity, which results in a LinearDensity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and LinearDensity

    • times

      public final LuminousFlux times(LuminousFlux v)
      Calculate the multiplication of Dimensionless and LuminousFlux, which results in a LuminousFlux scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and LuminousFlux

    • times

      public final LuminousIntensity times(LuminousIntensity v)
      Calculate the multiplication of Dimensionless and LuminousIntensity, which results in a LuminousIntensity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and LuminousIntensity

    • times

      public final MagneticFluxDensity times(MagneticFluxDensity v)
      Calculate the multiplication of Dimensionless and MagneticFluxDensity, which results in a MagneticFluxDensity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and MagneticFluxDensity

    • times

      public final MagneticFlux times(MagneticFlux v)
      Calculate the multiplication of Dimensionless and MagneticFlux, which results in a MagneticFlux scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and MagneticFlux

    • times

      public final Mass times(Mass v)
      Calculate the multiplication of Dimensionless and Mass, which results in a Mass scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Mass

    • times

      public final Power times(Power v)
      Calculate the multiplication of Dimensionless and Power, which results in a Power scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Power

    • times

      public final Pressure times(Pressure v)
      Calculate the multiplication of Dimensionless and Pressure, which results in a Pressure scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Pressure

    • times

      public final RadioActivity times(RadioActivity v)
      Calculate the multiplication of Dimensionless and RadioActivity, which results in a RadioActivity scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and RadioActivity

    • times

      public final Speed times(Speed v)
      Calculate the multiplication of Dimensionless and Speed, which results in a Speed scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Speed

    • times

      public final Temperature times(Temperature v)
      Calculate the multiplication of Dimensionless and Temperature, which results in a Temperature scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Temperature

    • times

      public final Duration times(Duration v)
      Calculate the multiplication of Dimensionless and Duration, which results in a Duration scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Duration

    • times

      public final Torque times(Torque v)
      Calculate the multiplication of Dimensionless and Torque, which results in a Torque scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Torque

    • times

      public final Volume times(Volume v)
      Calculate the multiplication of Dimensionless and Volume, which results in a Volume scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of Dimensionless and Volume

    • divide

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

    • divide

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

    • divide

      public final 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 final 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

      public final ElectricalResistance divide(ElectricalConductance v)
      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

      public final ElectricalConductance divide(ElectricalResistance v)
      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: DoubleScalarRel
      Create the reciprocal of this scalar with the correct dimensions.
      Overrides:
      reciprocal in class DoubleScalarRel<DimensionlessUnit,Dimensionless>
      Returns:
      a new scalar instance with correct SI dimensions

    • multiply

      public static Dimensionless multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
      Multiply two scalars that result in a scalar of type Dimensionless.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the multiplication of both scalars as an instance of Dimensionless

    • divide

      public static Dimensionless divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
      Divide two scalars that result in a scalar of type Dimensionless.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the division of scalar1 by scalar2 as an instance of Dimensionless