Package org.djunits.value.vfloat.scalar

Class FloatEnergy

    • Field Detail

      • ZERO

        public static final FloatEnergy ZERO
        Constant with value zero.

      • ONE

        public static final FloatEnergy ONE
        Constant with value one.

      • NaN

        public static final FloatEnergy NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatEnergy POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatEnergy NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatEnergy POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatEnergy NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatEnergy

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

      • FloatEnergy

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

      • FloatEnergy

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

    • Method Detail

      • instantiateRel

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

      • interpolate

        public static FloatEnergy interpolate​(FloatEnergy zero,
                                      FloatEnergy 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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • divide

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

      • divide

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

      • times

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • times

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

      • divide

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

      • divide

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