Package org.djunits.value.vdouble.scalar

Class LinearDensity

    • Field Detail

      • ZERO

        public static final LinearDensity ZERO
        Constant with value zero.

      • ONE

        public static final LinearDensity ONE
        Constant with value one.

      • NaN

        public static final LinearDensity NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final LinearDensity POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final LinearDensity NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final LinearDensity POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final LinearDensity NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • LinearDensity

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

      • LinearDensity

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

    • Method Detail

      • instantiateRel

        public final LinearDensity instantiateRel​(double value,
                                          LinearDensityUnit unit)
        Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
        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 LinearDensity instantiateSI​(double value)
        Construct LinearDensity scalar.
        Parameters:
        value - double; the double value in SI units
        Returns:
        LinearDensity; the new scalar with the SI value

      • interpolate

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

      • max

        public static LinearDensity max​(LinearDensity r1,
                                LinearDensity r2)
        Return the maximum value of two relative scalars.
        Parameters:
        r1 - LinearDensity; the first scalar
        r2 - LinearDensity; the second scalar
        Returns:
        LinearDensity; the maximum value of two relative scalars

      • max

        public static LinearDensity max​(LinearDensity r1,
                                LinearDensity r2,
                                LinearDensity... rn)
        Return the maximum value of more than two relative scalars.
        Parameters:
        r1 - LinearDensity; the first scalar
        r2 - LinearDensity; the second scalar
        rn - LinearDensity...; the other scalars
        Returns:
        LinearDensity; the maximum value of more than two relative scalars

      • min

        public static LinearDensity min​(LinearDensity r1,
                                LinearDensity r2)
        Return the minimum value of two relative scalars.
        Parameters:
        r1 - LinearDensity; the first scalar
        r2 - LinearDensity; the second scalar
        Returns:
        LinearDensity; the minimum value of two relative scalars

      • min

        public static LinearDensity min​(LinearDensity r1,
                                LinearDensity r2,
                                LinearDensity... rn)
        Return the minimum value of more than two relative scalars.
        Parameters:
        r1 - LinearDensity; the first scalar
        r2 - LinearDensity; the second scalar
        rn - LinearDensity...; the other scalars
        Returns:
        LinearDensity; the minimum value of more than two relative scalars

      • valueOf

        public static LinearDensity valueOf​(String text)
        Returns a LinearDensity 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 LinearDensity
        Returns:
        LinearDensity; 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 LinearDensity of​(double value,
                               String unitString)
        Returns a LinearDensity 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:
        LinearDensity; 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 Dimensionless divide​(LinearDensity v)
        Calculate the division of LinearDensity and LinearDensity, which results in a Dimensionless scalar.
        Parameters:
        v - LinearDensity scalar
        Returns:
        Dimensionless scalar as a division of LinearDensity and LinearDensity

      • times

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

      • times

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

      • times

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