Package org.djunits.value.vfloat.scalar

Class FloatFrequency

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,​R>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<FrequencyUnit,​FloatFrequency>
org.djunits.value.vfloat.scalar.FloatFrequency
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatFrequency>, Scalar<FrequencyUnit,​FloatFrequency>, Scalar.Rel<FrequencyUnit,​FloatFrequency>, ValueFunctions<FrequencyUnit,​FloatFrequency>, Relative<FrequencyUnit,​FloatFrequency>, Value<FrequencyUnit,​FloatFrequency>, FloatScalarInterface<FrequencyUnit,​FloatFrequency>, FloatScalarInterface.Rel<FrequencyUnit,​FloatFrequency>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatFrequency
extends AbstractFloatScalarRel<FrequencyUnit,​FloatFrequency>
Easy access methods for the FloatFrequency FloatScalar, 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

  • Constructor Details

    • FloatFrequency

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

    • FloatFrequency

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

    • FloatFrequency

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

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • times

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

    • times

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

    • times

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

    • times

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