FloatFrequency (DJUNITS 1.02.01 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar<U>
  - - org.djunits.value.vfloat.scalar.FloatScalar<U>
    - - org.djunits.value.vfloat.scalar.FloatScalar.Rel<FrequencyUnit>
      - org.djunits.value.vfloat.scalar.FloatFrequency

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<FrequencyUnit>>, MathFunctions<FloatScalar<FrequencyUnit>>, Relative, Value<FrequencyUnit>, FloatMathFunctions<FloatScalar<FrequencyUnit>>
```
public class FloatFrequency
extends FloatScalar.Rel<FrequencyUnit>
implements Relative
```
Easy access methods for the Frequency FloatScalar, which is relative by definition. An example is Speed. Instead of
FloatScalar.Rel<FrequencyUnit> value = new FloatScalar.Rel<FrequencyUnit>(100.0, FrequencyUnit.SI);
we can now write
FloatFrequency value = new FloatFrequency(100.0, FrequencyUnit.SI);
The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.
Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2015-10-04 20:47:10 +0200 (Sun, 04 Oct 2015) $, @version $Revision: 86 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.djunits.value.vfloat.scalar.FloatScalar
  FloatScalar.Abs<U extends Unit<U>>, FloatScalar.Rel<U extends Unit<U>>

Field Summary
- Fields inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel
  si

Constructor Summary

Constructors
Constructor and Description
`FloatFrequency(double value, FrequencyUnit unit)` Construct FloatFrequency scalar using a double value.
`FloatFrequency(float value, FrequencyUnit unit)` Construct FloatFrequency scalar.
`FloatFrequency(FloatScalar.Rel<FrequencyUnit> value)` Construct FloatFrequency scalar.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FloatFrequency`	`abs()` Set the value(s) to their absolute value.
`FloatFrequency`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`FloatFrequency`	`asin()` Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
`FloatFrequency`	`atan()` Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
`FloatFrequency`	`cbrt()` Set the value(s) to the(ir) cube root.
`FloatFrequency`	`ceil()` Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
`FloatFrequency`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`FloatFrequency`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`FloatFrequency`	`divideBy(double factor)` Divide scalar by a double factor.
`FloatFrequency`	`divideBy(float divisor)` Scale the value(s) by the inverse of a factor; i.e.
`FloatDimensionless.Rel`	`divideBy(FloatFrequency v)` Calculate the division of FloatFrequency and FloatFrequency, which results in a FloatDimensionless scalar.
`FloatFrequency`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`FloatFrequency`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`FloatFrequency`	`floor()` Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
`static FloatFrequency`	`interpolate(FloatFrequency zero, FloatFrequency one, double ratio)` Interpolate between two values.
`static FloatFrequency`	`interpolate(FloatFrequency zero, FloatFrequency one, float ratio)` Interpolate between two values.
`FloatFrequency`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`FloatFrequency`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`FloatFrequency`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`FloatFrequency`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`FloatFrequency`	`minus(FloatFrequency v)` Relative scalar minus Relative scalar = Relative scalar.
`FloatFrequency`	`multiplyBy(double factor)` Multiply scalar with a double factor.
`FloatFrequency`	`multiplyBy(float factor)` Scale the value(s) by a factor.
`FloatPower`	`multiplyBy(FloatEnergy v)` Calculate the multiplication of FloatFrequency and FloatEnergy, which results in a FloatPower scalar.
`FloatSpeed`	`multiplyBy(FloatLength.Rel v)` Calculate the multiplication of FloatFrequency and FloatLength, which results in a FloatSpeed scalar.
`FloatMoneyPerTime`	`multiplyBy(FloatMoney v)` Calculate the multiplication of FloatFrequency and FloatMoney, which results in a FloatMoneyPerTime scalar.
`FloatAcceleration`	`multiplyBy(FloatSpeed v)` Calculate the multiplication of FloatFrequency and FloatSpeed, which results in a FloatAcceleration scalar.
`FloatDimensionless.Rel`	`multiplyBy(FloatTime.Rel v)` Calculate the multiplication of FloatFrequency and FloatTime, which results in a FloatDimensionless scalar.
`FloatFrequency`	`plus(FloatFrequency v)` Relative scalar plus Relative scalar = Relative scalar.
`FloatFrequency`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`FloatFrequency`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`FloatFrequency`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`FloatFrequency`	`signum()` Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
`FloatFrequency`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`FloatFrequency`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`FloatFrequency`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`FloatFrequency`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`FloatFrequency`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`FloatFrequency`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`FloatFrequency`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel
compareTo, eq, ge, getSI, gt, le, lt, minus, ne, plus

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar
divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, hashCode, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, plus, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FloatFrequency
```
public FloatFrequency(float value,
                      FrequencyUnit unit)
```
    Construct FloatFrequency scalar.
    
    Parameters:
    
    value - float value
    
    unit - unit for the float value
  - FloatFrequency
```
public FloatFrequency(double value,
                      FrequencyUnit unit)
```
    Construct FloatFrequency scalar using a double value.
    
    Parameters:
    
    value - double value
    
    unit - unit for the value
  - FloatFrequency
```
public FloatFrequency(FloatScalar.Rel<FrequencyUnit> value)
```
    Construct FloatFrequency scalar.
    
    Parameters:
    
    value - Scalar from which to construct this instance
- Method Detail
  - 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 - the ratio between 0 and 1, inclusive
    
    Returns:
    
    a Scalar at the ratio between
  - interpolate
```
public static FloatFrequency interpolate(FloatFrequency zero,
                                         FloatFrequency one,
                                         double ratio)
```
    Interpolate between two values.
    
    Parameters:
    
    zero - the low value
    
    one - the high value
    
    ratio - the ratio between 0 and 1, inclusive
    
    Returns:
    
    a Scalar at the ratio between
  - abs
```
public final FloatFrequency abs()
```
    Set the value(s) to their absolute value.
    
    Specified by:
    
    abs in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    abs in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - acos
```
public final FloatFrequency acos()
```
    Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
    
    Specified by:
    
    acos in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    acos in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - asin
```
public final FloatFrequency asin()
```
    Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
    
    Specified by:
    
    asin in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    asin in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - atan
```
public final FloatFrequency atan()
```
    Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
    
    Specified by:
    
    atan in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    atan in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - cbrt
```
public final FloatFrequency cbrt()
```
    Set the value(s) to the(ir) cube root.
    
    Specified by:
    
    cbrt in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    cbrt in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - ceil
```
public final FloatFrequency ceil()
```
    Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
    
    Specified by:
    
    ceil in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    ceil in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - cos
```
public final FloatFrequency cos()
```
    Set the value(s) to the trigonometric cosine of the value(s).
    
    Specified by:
    
    cos in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    cos in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - cosh
```
public final FloatFrequency cosh()
```
    Set the value(s) to the hyperbolic cosine of the value(s).
    
    Specified by:
    
    cosh in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    cosh in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - exp
```
public final FloatFrequency exp()
```
    Set the value(s) to Euler's number e raised to the power of the value(s).
    
    Specified by:
    
    exp in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    exp in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - expm1
```
public final FloatFrequency expm1()
```
    Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
    
    Specified by:
    
    expm1 in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    expm1 in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - floor
```
public final FloatFrequency floor()
```
    Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
    
    Specified by:
    
    floor in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    floor in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - log
```
public final FloatFrequency log()
```
    Set the value(s) to the natural logarithm (base e) of the value(s).
    
    Specified by:
    
    log in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    log in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - log10
```
public final FloatFrequency log10()
```
    Set the value(s) to the base 10 logarithm of the value(s).
    
    Specified by:
    
    log10 in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    log10 in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - log1p
```
public final FloatFrequency log1p()
```
    Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
    
    Specified by:
    
    log1p in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    log1p in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - rint
```
public final FloatFrequency rint()
```
    Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
    
    Specified by:
    
    rint in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    rint in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - round
```
public final FloatFrequency round()
```
    Set the value(s) to the closest long to the argument with ties rounding up.
    
    Specified by:
    
    round in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    round in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - signum
```
public final FloatFrequency signum()
```
    Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
    
    Specified by:
    
    signum in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    signum in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - sin
```
public final FloatFrequency sin()
```
    Set the value(s) to the trigonometric sine of the value(s).
    
    Specified by:
    
    sin in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    sin in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - sinh
```
public final FloatFrequency sinh()
```
    Set the value(s) to the hyperbolic sine of the value(s).
    
    Specified by:
    
    sinh in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    sinh in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - sqrt
```
public final FloatFrequency sqrt()
```
    Set the value(s) to the correctly rounded positive square root of the value(s).
    
    Specified by:
    
    sqrt in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    sqrt in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - tan
```
public final FloatFrequency tan()
```
    Set the value(s) to the trigonometric tangent of the value(s).
    
    Specified by:
    
    tan in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    tan in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - tanh
```
public final FloatFrequency tanh()
```
    Set the value(s) to the hyperbolic tangent of the value(s).
    
    Specified by:
    
    tanh in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    tanh in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - inv
```
public final FloatFrequency inv()
```
    Set the value(s) to the complement (1.0/x) of the value(s).
    
    Specified by:
    
    inv in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    inv in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - toDegrees
```
public final FloatFrequency toDegrees()
```
    Set the value(s) to approximately equivalent angle(s) measured in degrees.
    
    Specified by:
    
    toDegrees in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    toDegrees in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - toRadians
```
public final FloatFrequency toRadians()
```
    Set the value(s) to approximately equivalent angle(s) measured in radians.
    
    Specified by:
    
    toRadians in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    toRadians in class FloatScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - pow
```
public final FloatFrequency pow(double x)
```
    Set the value(s) to the value(s) raised to the power of the argument.
    
    Specified by:
    
    pow in interface MathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    pow in class FloatScalar.Rel<FrequencyUnit>
    
    Parameters:
    
    x - double; the value to use as the power
    
    Returns:
    
    T; the modified T
  - multiplyBy
```
public final FloatFrequency multiplyBy(float factor)
```
    Scale the value(s) by a factor.
    
    Specified by:
    
    multiplyBy in interface FloatMathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    multiplyBy in class FloatScalar.Rel<FrequencyUnit>
    
    Parameters:
    
    factor - float; the multiplier
    
    Returns:
    
    T; the modified T
  - multiplyBy
```
public final FloatFrequency multiplyBy(double factor)
```
    Multiply scalar with a double factor.
    
    Parameters:
    
    factor - the factor to multiply with
    
    Returns:
    
    new instance of a relative frequency
  - divideBy
```
public final FloatFrequency divideBy(float divisor)
```
    Scale the value(s) by the inverse of a factor; i.e. a divisor.
    
    Specified by:
    
    divideBy in interface FloatMathFunctions<FloatScalar<FrequencyUnit>>
    
    Overrides:
    
    divideBy in class FloatScalar.Rel<FrequencyUnit>
    
    Parameters:
    
    divisor - float; the divisor
    
    Returns:
    
    T; the modified T
  - divideBy
```
public final FloatFrequency divideBy(double factor)
```
    Divide scalar by a double factor.
    
    Parameters:
    
    factor - the factor to divide by
    
    Returns:
    
    new instance of a relative frequency
  - plus
```
public final FloatFrequency plus(FloatFrequency v)
```
    Relative scalar plus Relative scalar = Relative scalar.
    
    Parameters:
    
    v - the value to add
    
    Returns:
    
    sum of this value and v as a new object
  - minus
```
public final FloatFrequency minus(FloatFrequency v)
```
    Relative scalar minus Relative scalar = Relative scalar.
    
    Parameters:
    
    v - the value to subtract
    
    Returns:
    
    difference of this value and v as a new object
  - divideBy
```
public final FloatDimensionless.Rel divideBy(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
  - multiplyBy
```
public final FloatDimensionless.Rel multiplyBy(FloatTime.Rel v)
```
    Calculate the multiplication of FloatFrequency and FloatTime, which results in a FloatDimensionless scalar.
    
    Parameters:
    
    v - FloatFrequency scalar
    
    Returns:
    
    FloatDimensionless scalar as a multiplication of FloatFrequency and FloatTime
  - multiplyBy
```
public final FloatSpeed multiplyBy(FloatLength.Rel 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
  - multiplyBy
```
public final FloatAcceleration multiplyBy(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
  - multiplyBy
```
public final FloatPower multiplyBy(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
  - multiplyBy
```
public final FloatMoneyPerTime multiplyBy(FloatMoney v)
```
    Calculate the multiplication of FloatFrequency and FloatMoney, which results in a FloatMoneyPerTime scalar.
    
    Parameters:
    
    v - FloatFrequency scalar
    
    Returns:
    
    FloatMoneyPerTime scalar as a multiplication of FloatFrequency and FloatMoney

Class FloatFrequency

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.scalar.FloatScalar

Field Summary

Fields inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

FloatFrequency

FloatFrequency

FloatFrequency

Method Detail

interpolate

interpolate

abs

acos

asin

atan

cbrt

ceil

cos

cosh

exp

expm1

floor

log

log10

log1p

rint

round

signum

sin

sinh

sqrt

tan

tanh

inv

toDegrees

toRadians

pow

multiplyBy

multiplyBy

divideBy

divideBy

plus

minus

divideBy

multiplyBy

multiplyBy

multiplyBy

multiplyBy

multiplyBy