Package org.djunits.value.vdouble.scalar

Class Power

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,​R>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<PowerUnit,​Power>
org.djunits.value.vdouble.scalar.Power
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Power>, Scalar<PowerUnit,​Power>, Scalar.Rel<PowerUnit,​Power>, ValueFunctions<PowerUnit,​Power>, Relative<PowerUnit,​Power>, Value<PowerUnit,​Power>, DoubleScalarInterface<PowerUnit,​Power>, DoubleScalarInterface.Rel<PowerUnit,​Power>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class Power
extends AbstractDoubleScalarRel<PowerUnit,​Power>
Easy access methods for the Power DoubleScalar, which is relative by definition.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:
Alexander Verbraeck, Peter Knoppers
See Also:
Serialized Form

  • Field Details

    • ZERO

      public static final Power ZERO
      Constant with value zero.

    • ONE

      public static final Power ONE
      Constant with value one.

    • NaN

      public static final Power NaN
      Constant with value NaN.

    • POSITIVE_INFINITY

      public static final Power POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.

    • NEGATIVE_INFINITY

      public static final Power NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.

    • POS_MAXVALUE

      public static final Power POS_MAXVALUE
      Constant with value MAX_VALUE.

    • NEG_MAXVALUE

      public static final Power NEG_MAXVALUE
      Constant with value -MAX_VALUE.

  • Constructor Details

    • Power

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

    • Power

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

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • max

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

    • max

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

    • min

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

    • min

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

    • valueOf

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

    • times

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

    • divide

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

    • divide

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

    • divide

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

    • divide

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

    • divide

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

    • divide

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