Package org.djunits.value.vdouble.scalar

Class Dimensionless

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,​R>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<DimensionlessUnit,​Dimensionless>
org.djunits.value.vdouble.scalar.Dimensionless
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Dimensionless>, Scalar<DimensionlessUnit,​Dimensionless>, Scalar.Rel<DimensionlessUnit,​Dimensionless>, DimensionlessFunctions<DimensionlessUnit,​Dimensionless>, ValueFunctions<DimensionlessUnit,​Dimensionless>, Relative<DimensionlessUnit,​Dimensionless>, Value<DimensionlessUnit,​Dimensionless>, DoubleScalarInterface<DimensionlessUnit,​Dimensionless>, DoubleScalarInterface.Rel<DimensionlessUnit,​Dimensionless>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class Dimensionless
extends AbstractDoubleScalarRel<DimensionlessUnit,​Dimensionless>
implements DimensionlessFunctions<DimensionlessUnit,​Dimensionless>
Easy access methods for the Dimensionless DoubleScalar, which is relative by definition.

Copyright (c) 2013-2019 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:
Serialized Form

  • Field Details

  • Constructor Details

    • Dimensionless

      public Dimensionless​(double value, DimensionlessUnit unit)
      Construct Dimensionless scalar.
      Parameters:
      value - double; the double value
      unit - DimensionlessUnit; unit for the double value

    • Dimensionless

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

  • Method Details

    • instantiateRel

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

    • instantiateSI

      public static final Dimensionless instantiateSI​(double value)
      Construct Dimensionless scalar.
      Parameters:
      value - double; the double value in SI units
      Returns:
      Dimensionless; the new scalar with the SI value

    • interpolate

      public static Dimensionless interpolate​(Dimensionless zero, Dimensionless one, double ratio)
      Interpolate between two values.
      Parameters:
      zero - Dimensionless; the low value
      one - Dimensionless; the high value
      ratio - double; the ratio between 0 and 1, inclusive
      Returns:
      Dimensionless; a Scalar at the ratio between

    • max

      public static Dimensionless max​(Dimensionless r1, Dimensionless r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - Dimensionless; the first scalar
      r2 - Dimensionless; the second scalar
      Returns:
      Dimensionless; 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 - Dimensionless; the first scalar
      r2 - Dimensionless; the second scalar
      rn - Dimensionless...; the other scalars
      Returns:
      Dimensionless; 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 - Dimensionless; the first scalar
      r2 - Dimensionless; the second scalar
      Returns:
      Dimensionless; 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 - Dimensionless; the first scalar
      r2 - Dimensionless; the second scalar
      rn - Dimensionless...; the other scalars
      Returns:
      Dimensionless; 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 the official abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
      Parameters:
      text - String; the textual representation to parse into a Dimensionless
      Returns:
      Dimensionless; 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.
      Parameters:
      value - double; the value to use
      unitString - String; the textual representation of the unit
      Returns:
      Dimensionless; 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

    • acos

      public final Dimensionless acos()
      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:
      T; the modified T

    • asin

      public final Dimensionless asin()
      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:
      T; the modified T

    • atan

      public final Dimensionless atan()
      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:
      T; the modified T

    • cbrt

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

    • cos

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

    • cosh

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

    • exp

      public final Dimensionless exp()
      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:
      T; the modified T

    • expm1

      public final Dimensionless expm1()
      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:
      T; the modified T

    • log

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

    • log10

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

    • log1p

      public final Dimensionless log1p()
      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:
      T; the modified T

    • pow

      public final Dimensionless pow​(double x)
      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 - double; the value to use as the power
      Returns:
      T; the modified T

    • signum

      public final Dimensionless signum()
      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:
      T; the modified T

    • sin

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

    • sinh

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

    • sqrt

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

    • tan

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

    • tanh

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

    • inv

      public final Dimensionless inv()
      Set the value(s) to the complement (1.0/x) of the value(s).
      Specified by:
      inv in interface DimensionlessFunctions<DimensionlessUnit,​Dimensionless>
      Returns:
      T; 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 - Dimensionless scalar
      Returns:
      Dimensionless 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 - Dimensionless scalar
      Returns:
      AbsorbedDose 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 - Dimensionless scalar
      Returns:
      Acceleration 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 - Dimensionless scalar
      Returns:
      AmountOfSubstance 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 - Dimensionless scalar
      Returns:
      Angle 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 - Dimensionless scalar
      Returns:
      SolidAngle 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 - Dimensionless scalar
      Returns:
      Area 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 - Dimensionless scalar
      Returns:
      CatalyticActivity 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 - Dimensionless scalar
      Returns:
      Density 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 - Dimensionless scalar
      Returns:
      Dimensionless 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 - Dimensionless scalar
      Returns:
      ElectricalCapacitance 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 - Dimensionless scalar
      Returns:
      ElectricalCharge 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 - Dimensionless scalar
      Returns:
      ElectricalConductance 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 - Dimensionless scalar
      Returns:
      ElectricalCurrent 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 - Dimensionless scalar
      Returns:
      ElectricalInductance 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 - Dimensionless scalar
      Returns:
      ElectricalPotential 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 - Dimensionless scalar
      Returns:
      ElectricalResistance 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 - Dimensionless scalar
      Returns:
      Energy 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 - Dimensionless scalar
      Returns:
      EquivalentDose 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 - Dimensionless scalar
      Returns:
      FlowMass 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 - Dimensionless scalar
      Returns:
      FlowVolume 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 - Dimensionless scalar
      Returns:
      Force 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 - Dimensionless scalar
      Returns:
      Frequency 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 - Dimensionless scalar
      Returns:
      Illuminance 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 - Dimensionless scalar
      Returns:
      Length 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 - Dimensionless scalar
      Returns:
      LinearDensity 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 - Dimensionless scalar
      Returns:
      LuminousFlux 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 - Dimensionless scalar
      Returns:
      LuminousIntensity 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 - Dimensionless scalar
      Returns:
      MagneticFluxDensity 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 - Dimensionless scalar
      Returns:
      MagneticFlux 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 - Dimensionless scalar
      Returns:
      Mass 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 - Dimensionless scalar
      Returns:
      Power 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 - Dimensionless scalar
      Returns:
      Pressure 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 - Dimensionless scalar
      Returns:
      RadioActivity 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 - Dimensionless scalar
      Returns:
      Speed 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 - Dimensionless scalar
      Returns:
      Temperature 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 - Dimensionless scalar
      Returns:
      Duration 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 - Dimensionless scalar
      Returns:
      Torque 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 - Dimensionless scalar
      Returns:
      Volume 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 - Dimensionless scalar
      Returns:
      LinearDensity 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 - Dimensionless scalar
      Returns:
      Length 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 - Dimensionless scalar
      Returns:
      Frequency 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 - Dimensionless scalar
      Returns:
      Duration scalar as a division of Dimensionless and Frequency