Package org.djunits.value.vdouble.scalar

Class Area

    • Field Detail

      • ZERO

        public static final Area ZERO
        Constant with value zero.

      • ONE

        public static final Area ONE
        Constant with value one.

      • NaN

        public static final Area NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final Area POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final Area NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final Area POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final Area NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • Area

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

      • Area

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

    • Method Detail

      • instantiateRel

        public final Area instantiateRel​(double value,
                                 AreaUnit 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 Area instantiateSI​(double value)
        Construct Area scalar.
        Parameters:
        value - double; the double value in SI units
        Returns:
        Area; the new scalar with the SI value

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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

      • divide

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

      • divide

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

      • divide

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

      • times

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

      • times

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

      • times

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

      • times

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