Class AngularVelocity

All Implemented Interfaces:
Serializable, Cloneable, Comparable<AngularVelocity>, Relative<AngularVelocityUnit,AngularVelocity>, Value<AngularVelocityUnit,AngularVelocity>

@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-07-23T14:06:38.224104100Z") public class AngularVelocity extends DoubleScalarRel<AngularVelocityUnit,AngularVelocity>
Easy access methods for the AngularVelocity DoubleScalar, which is relative by definition.

Copyright (c) 2013-2024 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:
  • Field Details

    • ZERO

      public static final AngularVelocity ZERO
      Constant with value zero.
    • ONE

      public static final AngularVelocity ONE
      Constant with value one.
    • NaN

      public static final AngularVelocity NaN
      Constant with value NaN.
    • POSITIVE_INFINITY

      public static final AngularVelocity POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.
    • NEGATIVE_INFINITY

      public static final AngularVelocity NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.
    • POS_MAXVALUE

      public static final AngularVelocity POS_MAXVALUE
      Constant with value MAX_VALUE.
    • NEG_MAXVALUE

      public static final AngularVelocity NEG_MAXVALUE
      Constant with value -MAX_VALUE.
  • Constructor Details

    • AngularVelocity

      public AngularVelocity(double value, AngularVelocityUnit unit)
      Construct AngularVelocity scalar.
      Parameters:
      value - double; the double value
      unit - AngularVelocityUnit; unit for the double value
    • AngularVelocity

      public AngularVelocity(AngularVelocity value)
      Construct AngularVelocity scalar.
      Parameters:
      value - AngularVelocity; Scalar from which to construct this instance
  • Method Details

    • instantiateRel

      public final AngularVelocity instantiateRel(double value, AngularVelocityUnit unit)
      Description copied from class: DoubleScalarRel
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class DoubleScalarRel<AngularVelocityUnit,AngularVelocity>
      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 AngularVelocity instantiateSI(double value)
      Construct AngularVelocity scalar.
      Parameters:
      value - double; the double value in SI units
      Returns:
      AngularVelocity; the new scalar with the SI value
    • interpolate

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

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

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

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

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

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

      public final Frequency divide(Angle v)
      Calculate the division of AngularVelocity and Angle, which results in a Frequency scalar.
      Parameters:
      v - AngularVelocity; scalar
      Returns:
      Frequency; scalar as a division of AngularVelocity and Angle
    • divide

      public final Angle divide(Frequency v)
      Calculate the division of AngularVelocity and Frequency, which results in a Angle scalar.
      Parameters:
      v - AngularVelocity; scalar
      Returns:
      Angle; scalar as a division of AngularVelocity and Frequency
    • times

      public final Angle times(Duration v)
      Calculate the multiplication of AngularVelocity and Duration, which results in a Angle scalar.
      Parameters:
      v - AngularVelocity; scalar
      Returns:
      Angle; scalar as a multiplication of AngularVelocity and Duration
    • divide

      public final AngularAcceleration divide(Duration v)
      Calculate the division of AngularVelocity and Duration, which results in a AngularAcceleration scalar.
      Parameters:
      v - AngularVelocity; scalar
      Returns:
      AngularAcceleration; scalar as a division of AngularVelocity and Duration
    • divide

      public final Duration divide(AngularAcceleration v)
      Calculate the division of AngularVelocity and AngularAcceleration, which results in a Duration scalar.
      Parameters:
      v - AngularVelocity; scalar
      Returns:
      Duration; scalar as a division of AngularVelocity and AngularAcceleration
    • times

      public final AngularAcceleration times(Frequency v)
      Calculate the multiplication of AngularVelocity and Frequency, which results in a AngularAcceleration scalar.
      Parameters:
      v - AngularVelocity; scalar
      Returns:
      AngularAcceleration; scalar as a multiplication of AngularVelocity and Frequency
    • reciprocal

      public SIScalar reciprocal()
      Description copied from class: DoubleScalarRel
      Create the reciprocal of this scalar with the correct dimensions.
      Specified by:
      reciprocal in class DoubleScalarRel<AngularVelocityUnit,AngularVelocity>
      Returns:
      DoubleScalar<?>; a new scalar instance with correct SI dimensions