Class FloatDimensionless

    • Constructor Detail

      • FloatDimensionless

        public FloatDimensionless​(float value,
                                  DimensionlessUnit unit)
        Construct FloatDimensionless scalar.
        Parameters:
        value - float; the float value
        unit - unit for the float value
      • FloatDimensionless

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

        public FloatDimensionless​(double value,
                                  DimensionlessUnit unit)
        Construct FloatDimensionless scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value
    • Method Detail

      • instantiateSI

        public static final FloatDimensionless instantiateSI​(float value)
        Construct FloatDimensionless scalar.
        Parameters:
        value - float; the float value in SI units
        Returns:
        the new scalar with the SI value
      • interpolate

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

        public static FloatDimensionless valueOf​(String text)
        Returns a FloatDimensionless 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 - String; the textual representation to parse into a FloatDimensionless
        Returns:
        FloatDimensionless; 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 FloatDimensionless of​(float value,
                                            String unitString)
        Returns a FloatDimensionless based on a value and the textual representation of the unit, which can be localized.
        Parameters:
        value - double; the value to use
        unitString - String; the textual representation of the unit
        Returns:
        FloatDimensionless; 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 AbstractFloatScalar<DimensionlessUnit,​FloatDimensionless>
        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 FloatDimensionless divide​(FloatDimensionless v)
        Calculate the division of FloatDimensionless and FloatDimensionless, which results in a FloatDimensionless scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatDimensionless; scalar as a division of FloatDimensionless and FloatDimensionless
      • times

        public final FloatAbsorbedDose times​(FloatAbsorbedDose v)
        Calculate the multiplication of FloatDimensionless and FloatAbsorbedDose, which results in a FloatAbsorbedDose scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatAbsorbedDose; scalar as a multiplication of FloatDimensionless and FloatAbsorbedDose
      • times

        public final FloatAcceleration times​(FloatAcceleration v)
        Calculate the multiplication of FloatDimensionless and FloatAcceleration, which results in a FloatAcceleration scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatAcceleration; scalar as a multiplication of FloatDimensionless and FloatAcceleration
      • times

        public final FloatAmountOfSubstance times​(FloatAmountOfSubstance v)
        Calculate the multiplication of FloatDimensionless and FloatAmountOfSubstance, which results in a FloatAmountOfSubstance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatAmountOfSubstance; scalar as a multiplication of FloatDimensionless and FloatAmountOfSubstance
      • times

        public final FloatAngle times​(FloatAngle v)
        Calculate the multiplication of FloatDimensionless and FloatAngle, which results in a FloatAngle scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatAngle; scalar as a multiplication of FloatDimensionless and FloatAngle
      • times

        public final FloatSolidAngle times​(FloatSolidAngle v)
        Calculate the multiplication of FloatDimensionless and FloatSolidAngle, which results in a FloatSolidAngle scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatSolidAngle; scalar as a multiplication of FloatDimensionless and FloatSolidAngle
      • times

        public final FloatArea times​(FloatArea v)
        Calculate the multiplication of FloatDimensionless and FloatArea, which results in a FloatArea scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatArea; scalar as a multiplication of FloatDimensionless and FloatArea
      • times

        public final FloatCatalyticActivity times​(FloatCatalyticActivity v)
        Calculate the multiplication of FloatDimensionless and FloatCatalyticActivity, which results in a FloatCatalyticActivity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatCatalyticActivity; scalar as a multiplication of FloatDimensionless and FloatCatalyticActivity
      • times

        public final FloatDensity times​(FloatDensity v)
        Calculate the multiplication of FloatDimensionless and FloatDensity, which results in a FloatDensity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatDensity; scalar as a multiplication of FloatDimensionless and FloatDensity
      • times

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

        public final FloatElectricalCapacitance times​(FloatElectricalCapacitance v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalCapacitance, which results in a FloatElectricalCapacitance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalCapacitance; scalar as a multiplication of FloatDimensionless and FloatElectricalCapacitance
      • times

        public final FloatElectricalCharge times​(FloatElectricalCharge v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalCharge, which results in a FloatElectricalCharge scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalCharge; scalar as a multiplication of FloatDimensionless and FloatElectricalCharge
      • times

        public final FloatElectricalConductance times​(FloatElectricalConductance v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalConductance, which results in a FloatElectricalConductance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalConductance; scalar as a multiplication of FloatDimensionless and FloatElectricalConductance
      • times

        public final FloatElectricalCurrent times​(FloatElectricalCurrent v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalCurrent, which results in a FloatElectricalCurrent scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalCurrent; scalar as a multiplication of FloatDimensionless and FloatElectricalCurrent
      • times

        public final FloatElectricalInductance times​(FloatElectricalInductance v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalInductance, which results in a FloatElectricalInductance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalInductance; scalar as a multiplication of FloatDimensionless and FloatElectricalInductance
      • times

        public final FloatElectricalPotential times​(FloatElectricalPotential v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalPotential, which results in a FloatElectricalPotential scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalPotential; scalar as a multiplication of FloatDimensionless and FloatElectricalPotential
      • times

        public final FloatElectricalResistance times​(FloatElectricalResistance v)
        Calculate the multiplication of FloatDimensionless and FloatElectricalResistance, which results in a FloatElectricalResistance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalResistance; scalar as a multiplication of FloatDimensionless and FloatElectricalResistance
      • times

        public final FloatEnergy times​(FloatEnergy v)
        Calculate the multiplication of FloatDimensionless and FloatEnergy, which results in a FloatEnergy scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatEnergy; scalar as a multiplication of FloatDimensionless and FloatEnergy
      • times

        public final FloatEquivalentDose times​(FloatEquivalentDose v)
        Calculate the multiplication of FloatDimensionless and FloatEquivalentDose, which results in a FloatEquivalentDose scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatEquivalentDose; scalar as a multiplication of FloatDimensionless and FloatEquivalentDose
      • times

        public final FloatFlowMass times​(FloatFlowMass v)
        Calculate the multiplication of FloatDimensionless and FloatFlowMass, which results in a FloatFlowMass scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatFlowMass; scalar as a multiplication of FloatDimensionless and FloatFlowMass
      • times

        public final FloatFlowVolume times​(FloatFlowVolume v)
        Calculate the multiplication of FloatDimensionless and FloatFlowVolume, which results in a FloatFlowVolume scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatFlowVolume; scalar as a multiplication of FloatDimensionless and FloatFlowVolume
      • times

        public final FloatForce times​(FloatForce v)
        Calculate the multiplication of FloatDimensionless and FloatForce, which results in a FloatForce scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatForce; scalar as a multiplication of FloatDimensionless and FloatForce
      • times

        public final FloatFrequency times​(FloatFrequency v)
        Calculate the multiplication of FloatDimensionless and FloatFrequency, which results in a FloatFrequency scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatFrequency; scalar as a multiplication of FloatDimensionless and FloatFrequency
      • times

        public final FloatIlluminance times​(FloatIlluminance v)
        Calculate the multiplication of FloatDimensionless and FloatIlluminance, which results in a FloatIlluminance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatIlluminance; scalar as a multiplication of FloatDimensionless and FloatIlluminance
      • times

        public final FloatLength times​(FloatLength v)
        Calculate the multiplication of FloatDimensionless and FloatLength, which results in a FloatLength scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatLength; scalar as a multiplication of FloatDimensionless and FloatLength
      • times

        public final FloatLinearDensity times​(FloatLinearDensity v)
        Calculate the multiplication of FloatDimensionless and FloatLinearDensity, which results in a FloatLinearDensity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatLinearDensity; scalar as a multiplication of FloatDimensionless and FloatLinearDensity
      • times

        public final FloatLuminousFlux times​(FloatLuminousFlux v)
        Calculate the multiplication of FloatDimensionless and FloatLuminousFlux, which results in a FloatLuminousFlux scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatLuminousFlux; scalar as a multiplication of FloatDimensionless and FloatLuminousFlux
      • times

        public final FloatLuminousIntensity times​(FloatLuminousIntensity v)
        Calculate the multiplication of FloatDimensionless and FloatLuminousIntensity, which results in a FloatLuminousIntensity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatLuminousIntensity; scalar as a multiplication of FloatDimensionless and FloatLuminousIntensity
      • times

        public final FloatMagneticFluxDensity times​(FloatMagneticFluxDensity v)
        Calculate the multiplication of FloatDimensionless and FloatMagneticFluxDensity, which results in a FloatMagneticFluxDensity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatMagneticFluxDensity; scalar as a multiplication of FloatDimensionless and FloatMagneticFluxDensity
      • times

        public final FloatMagneticFlux times​(FloatMagneticFlux v)
        Calculate the multiplication of FloatDimensionless and FloatMagneticFlux, which results in a FloatMagneticFlux scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatMagneticFlux; scalar as a multiplication of FloatDimensionless and FloatMagneticFlux
      • times

        public final FloatMass times​(FloatMass v)
        Calculate the multiplication of FloatDimensionless and FloatMass, which results in a FloatMass scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatMass; scalar as a multiplication of FloatDimensionless and FloatMass
      • times

        public final FloatPower times​(FloatPower v)
        Calculate the multiplication of FloatDimensionless and FloatPower, which results in a FloatPower scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatPower; scalar as a multiplication of FloatDimensionless and FloatPower
      • times

        public final FloatPressure times​(FloatPressure v)
        Calculate the multiplication of FloatDimensionless and FloatPressure, which results in a FloatPressure scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatPressure; scalar as a multiplication of FloatDimensionless and FloatPressure
      • times

        public final FloatRadioActivity times​(FloatRadioActivity v)
        Calculate the multiplication of FloatDimensionless and FloatRadioActivity, which results in a FloatRadioActivity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatRadioActivity; scalar as a multiplication of FloatDimensionless and FloatRadioActivity
      • times

        public final FloatSpeed times​(FloatSpeed v)
        Calculate the multiplication of FloatDimensionless and FloatSpeed, which results in a FloatSpeed scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatSpeed; scalar as a multiplication of FloatDimensionless and FloatSpeed
      • times

        public final FloatTemperature times​(FloatTemperature v)
        Calculate the multiplication of FloatDimensionless and FloatTemperature, which results in a FloatTemperature scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatTemperature; scalar as a multiplication of FloatDimensionless and FloatTemperature
      • times

        public final FloatDuration times​(FloatDuration v)
        Calculate the multiplication of FloatDimensionless and FloatDuration, which results in a FloatDuration scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatDuration; scalar as a multiplication of FloatDimensionless and FloatDuration
      • times

        public final FloatTorque times​(FloatTorque v)
        Calculate the multiplication of FloatDimensionless and FloatTorque, which results in a FloatTorque scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatTorque; scalar as a multiplication of FloatDimensionless and FloatTorque
      • times

        public final FloatVolume times​(FloatVolume v)
        Calculate the multiplication of FloatDimensionless and FloatVolume, which results in a FloatVolume scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatVolume; scalar as a multiplication of FloatDimensionless and FloatVolume
      • divide

        public final FloatLinearDensity divide​(FloatLength v)
        Calculate the division of FloatDimensionless and FloatLength, which results in a FloatLinearDensity scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatLinearDensity; scalar as a division of FloatDimensionless and FloatLength
      • divide

        public final FloatLength divide​(FloatLinearDensity v)
        Calculate the division of FloatDimensionless and FloatLinearDensity, which results in a FloatLength scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatLength; scalar as a division of FloatDimensionless and FloatLinearDensity
      • divide

        public final FloatFrequency divide​(FloatDuration v)
        Calculate the division of FloatDimensionless and FloatDuration, which results in a FloatFrequency scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatFrequency; scalar as a division of FloatDimensionless and FloatDuration
      • divide

        public final FloatDuration divide​(FloatFrequency v)
        Calculate the division of FloatDimensionless and FloatFrequency, which results in a FloatDuration scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatDuration; scalar as a division of FloatDimensionless and FloatFrequency
      • divide

        public final FloatElectricalResistance divide​(FloatElectricalConductance v)
        Calculate the division of FloatDimensionless and FloatElectricalConductance, which results in a FloatElectricalResistance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalResistance; scalar as a division of FloatDimensionless and FloatElectricalConductance
      • divide

        public final FloatElectricalConductance divide​(FloatElectricalResistance v)
        Calculate the division of FloatDimensionless and FloatElectricalResistance, which results in a FloatElectricalConductance scalar.
        Parameters:
        v - FloatDimensionless; scalar
        Returns:
        FloatElectricalConductance; scalar as a division of FloatDimensionless and FloatElectricalResistance