Class Dimensionless

    • Field Detail

      • 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 Detail

      • 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 Detail

      • 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
      • toStringSIPrefixed

        public String toStringSIPrefixed​(int smallestPower,
                                         int biggestPower)
        Format this AbstractDoubleScalar 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 AbstractDoubleScalar<DimensionlessUnit,​Dimensionless>
        Parameters:
        smallestPower - int; the smallest exponent value that will be written using an SI prefix
        biggestPower - int; the largest exponent value that will be written using an SI prefix
        Returns:
        String; formatted value of this AbstractDoubleScalar
      • 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
      • divide

        public final ElectricalResistance divide​(ElectricalConductance v)
        Calculate the division of Dimensionless and ElectricalConductance, which results in a ElectricalResistance scalar.
        Parameters:
        v - Dimensionless; scalar
        Returns:
        ElectricalResistance; 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 - Dimensionless; scalar
        Returns:
        ElectricalConductance; scalar as a division of Dimensionless and ElectricalResistance