Package org.djunits.value.vfloat.scalar

Class FloatLinearDensity

    • Constructor Detail

      • FloatLinearDensity

        public FloatLinearDensity​(float value,
                          LinearDensityUnit unit)
        Construct FloatLinearDensity scalar.
        Parameters:
        value - float; the float value
        unit - unit for the float value

      • FloatLinearDensity

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

      • FloatLinearDensity

        public FloatLinearDensity​(double value,
                          LinearDensityUnit unit)
        Construct FloatLinearDensity scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value

    • Method Detail

      • instantiateRel

        public final FloatLinearDensity instantiateRel​(float value,
                                               LinearDensityUnit unit)
        Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - float; the float value
        unit - U; the unit
        Returns:
        R a new relative instance of the FloatScalar of the right type

      • instantiateSI

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

      • interpolate

        public static FloatLinearDensity interpolate​(FloatLinearDensity zero,
                                             FloatLinearDensity 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 FloatLinearDensity valueOf​(String text)
        Returns a FloatLinearDensity 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 FloatLinearDensity
        Returns:
        FloatLinearDensity; 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 FloatLinearDensity of​(float value,
                                    String unitString)
        Returns a FloatLinearDensity 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:
        FloatLinearDensity; 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

      • divide

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

      • times

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

      • times

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

      • times

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