Package org.djunits.quantity
Class Dimensionless
- All Implemented Interfaces:
Serializable,Comparable<Dimensionless>,Additive<Dimensionless>,Scalable<Dimensionless>,Value<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 Summary
FieldsModifier and TypeFieldDescriptionstatic final DimensionlessConstant with value NaN.static final DimensionlessConstant with value -MAX_VALUE.static final DimensionlessConstant with value NEGATIVE_INFINITY.static final DimensionlessConstant with value one.static final DimensionlessConstant with value MAX_VALUE.static final DimensionlessConstant with value POSITIVE_INFINITY.static final DimensionlessConstant with value zero. -
Constructor Summary
ConstructorsConstructorDescriptionDimensionless(double valueInUnit, Unitless unit) Instantiate a Dimensionless quantity expressed in the given unit.Dimensionless(double value, Unitless displayUnit, boolean useSi) Instantiate a Dimensionless quantity with an SI or base value and a display unit. -
Method Summary
Modifier and TypeMethodDescriptionCalculate the division of Dimensionless and Dimensionless, which results in a Dimensionless quantity.Calculate the division of Dimensionless and Duration, which results in a Frequency scalar.Calculate the division of Dimensionless and ElectricalConductance, which results in a ElectricalResistance scalar.Calculate the division of Dimensionless and ElectricalResistance, which results in a ElectricalConductance scalar.Calculate the division of Dimensionless and Frequency, which results in a Duration scalar.Calculate the division of Dimensionless and Length, which results in a LinearObjectDensity scalar.Calculate the division of Dimensionless and LinearObjectDensity, which results in a Length scalar.Retrieve the unit of this Value.instantiateSi(double siValue, UnitInterface<Dimensionless> displayUnit) Instantiate a quantity with an SI or base value, and a display unit.static DimensionlessReturns a Dimensionless based on a value and the textual representation of the unit, which can be localized.static DimensionlessReturns a Dimensionless based on a value expressed in the unit.static DimensionlessofSi(double si) Return a Dimensionless instance based on an SI value.static DimensionlessInstantiate a Dimensionless quantity with an SI or base value and a display unit.Return the reciprocal of this quantity (1/q).static DimensionlessReturns a Dimensionless representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.quantity.def.Quantity
abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, scaleBy, si, siUnit, subtract, sum, toString, valueOfMethods inherited from class java.lang.Number
byteValue, shortValueMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.djunits.value.Value
isAbsolute
-
Field Details
-
ZERO
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
Dimensionless
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 unitdisplayUnit- the display unit to useuseSi- use SI value when true, use value in unit when false
-
Dimensionless
Instantiate a Dimensionless quantity expressed in the given unit.- Parameters:
valueInUnit- the quantity value expressed in the given unitunit- the unit of the value, also acts as the display unit
-
-
Method Details
-
ofSi
Return a Dimensionless instance based on an SI value.- Parameters:
si- the si value- Returns:
- the Dimensionless instance based on an SI value
-
ofSi
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 unitdisplayUnit- the display unit to use- Returns:
- the Dimensionless instance based on an SI value with the given display unit
-
instantiateSi
Description copied from class:QuantityInstantiate a quantity with an SI or base value, and a display unit.- Specified by:
instantiateSiin classQuantity<Dimensionless>- Parameters:
siValue- the value expressed in the base (SI) unitdisplayUnit- the display unit to use for the quantity- Returns:
- a quantity with the given SI or base value, and the given display unit
-
valueOf
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 parsedNullPointerException- when the text argument is null
-
of
Returns a Dimensionless based on a value expressed in the unit.- Parameters:
valueInUnit- the value, expressed in the given unitunit- the unit of the value, also acts as the display unit- Returns:
- ab Dimensionless representation of the value in its unit
-
of
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 unitStringunitString- 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 incorrectNullPointerException- when the unitString argument is null
-
getDisplayUnit
Description copied from interface:ValueRetrieve the unit of this Value.- Specified by:
getDisplayUnitin interfaceValue<Dimensionless>- Overrides:
getDisplayUnitin classQuantity<Dimensionless>- Returns:
- the unit of this Value
-
divide
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
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
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
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
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
Description copied from class:QuantityReturn the reciprocal of this quantity (1/q).- Overrides:
reciprocalin classQuantity<Dimensionless>- Returns:
- the reciprocal of this quantity, with the correct SI units
-