Frequency (DJUNITS 1.02.01 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar<U>
  - - org.djunits.value.vdouble.scalar.DoubleScalar<U>
    - - org.djunits.value.vdouble.scalar.DoubleScalar.Rel<FrequencyUnit>
      - org.djunits.value.vdouble.scalar.Frequency

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Rel<FrequencyUnit>>, MathFunctions<DoubleScalar<FrequencyUnit>>, Relative, Value<FrequencyUnit>, DoubleMathFunctions<DoubleScalar<FrequencyUnit>>
```
public class Frequency
extends DoubleScalar.Rel<FrequencyUnit>
implements Relative
```
Easy access methods for the Frequency DoubleScalar, which is relative by definition. An example is Speed. Instead of
DoubleScalar.Rel<FrequencyUnit> value = new DoubleScalar.Rel<FrequencyUnit>(100.0, FrequencyUnit.SI);
we can now write
Frequency value = new Frequency(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:45:14 +0200 (Sun, 04 Oct 2015) $, @version $Revision: 85 $, 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.vdouble.scalar.DoubleScalar
  DoubleScalar.Abs<U extends Unit<U>>, DoubleScalar.Rel<U extends Unit<U>>

Field Summary
- Fields inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel
  si

Constructor Summary

Constructors
Constructor and Description
`Frequency(double value, FrequencyUnit unit)` Construct Frequency scalar.
`Frequency(DoubleScalar.Rel<FrequencyUnit> value)` Construct Frequency scalar.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Frequency`	`abs()` Set the value(s) to their absolute value.
`Frequency`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`Frequency`	`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.
`Frequency`	`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.
`Frequency`	`cbrt()` Set the value(s) to the(ir) cube root.
`Frequency`	`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.
`Frequency`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`Frequency`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`Frequency`	`divideBy(double divisor)` Scale the value(s) by the inverse of a factor; i.e.
`Dimensionless.Rel`	`divideBy(Frequency v)` Calculate the division of Frequency and Frequency, which results in a Dimensionless scalar.
`Frequency`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`Frequency`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`Frequency`	`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 Frequency`	`interpolate(Frequency zero, Frequency one, double ratio)` Interpolate between two values.
`Frequency`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`Frequency`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`Frequency`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`Frequency`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`Frequency`	`minus(Frequency v)` Relative scalar minus Relative scalar = Relative scalar.
`Frequency`	`multiplyBy(double factor)` Scale the value(s) by a factor.
`Power`	`multiplyBy(Energy v)` Calculate the multiplication of Frequency and Energy, which results in a Power scalar.
`Speed`	`multiplyBy(Length.Rel v)` Calculate the multiplication of Frequency and Length, which results in a Speed scalar.
`MoneyPerTime`	`multiplyBy(Money v)` Calculate the multiplication of Frequency and Money, which results in a MoneyPerTime scalar.
`Acceleration`	`multiplyBy(Speed v)` Calculate the multiplication of Frequency and Speed, which results in a Acceleration scalar.
`Dimensionless.Rel`	`multiplyBy(Time.Rel v)` Calculate the multiplication of Frequency and Time, which results in a Dimensionless scalar.
`Frequency`	`plus(Frequency v)` Relative scalar plus Relative scalar = Relative scalar.
`Frequency`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`Frequency`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`Frequency`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`Frequency`	`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.
`Frequency`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`Frequency`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`Frequency`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`Frequency`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`Frequency`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`Frequency`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`Frequency`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

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

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar
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
  - Frequency
```
public Frequency(double value,
                 FrequencyUnit unit)
```
    Construct Frequency scalar.
    
    Parameters:
    
    value - double value
    
    unit - unit for the double value
  - Frequency
```
public Frequency(DoubleScalar.Rel<FrequencyUnit> value)
```
    Construct Frequency scalar.
    
    Parameters:
    
    value - Scalar from which to construct this instance
- Method Detail
  - interpolate
```
public static Frequency interpolate(Frequency zero,
                                    Frequency 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 Frequency abs()
```
    Set the value(s) to their absolute value.
    
    Specified by:
    
    abs in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    abs in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - acos
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    acos in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - asin
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    asin in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - atan
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    atan in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - cbrt
```
public final Frequency cbrt()
```
    Set the value(s) to the(ir) cube root.
    
    Specified by:
    
    cbrt in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    cbrt in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - ceil
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    ceil in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - cos
```
public final Frequency cos()
```
    Set the value(s) to the trigonometric cosine of the value(s).
    
    Specified by:
    
    cos in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    cos in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - cosh
```
public final Frequency cosh()
```
    Set the value(s) to the hyperbolic cosine of the value(s).
    
    Specified by:
    
    cosh in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    cosh in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - exp
```
public final Frequency exp()
```
    Set the value(s) to Euler's number e raised to the power of the value(s).
    
    Specified by:
    
    exp in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    exp in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - expm1
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    expm1 in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - floor
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    floor in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - log
```
public final Frequency log()
```
    Set the value(s) to the natural logarithm (base e) of the value(s).
    
    Specified by:
    
    log in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    log in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - log10
```
public final Frequency log10()
```
    Set the value(s) to the base 10 logarithm of the value(s).
    
    Specified by:
    
    log10 in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    log10 in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - log1p
```
public final Frequency log1p()
```
    Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
    
    Specified by:
    
    log1p in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    log1p in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - rint
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    rint in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - round
```
public final Frequency round()
```
    Set the value(s) to the closest long to the argument with ties rounding up.
    
    Specified by:
    
    round in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    round in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - signum
```
public final Frequency 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<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    signum in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - sin
```
public final Frequency sin()
```
    Set the value(s) to the trigonometric sine of the value(s).
    
    Specified by:
    
    sin in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    sin in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - sinh
```
public final Frequency sinh()
```
    Set the value(s) to the hyperbolic sine of the value(s).
    
    Specified by:
    
    sinh in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    sinh in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - sqrt
```
public final Frequency sqrt()
```
    Set the value(s) to the correctly rounded positive square root of the value(s).
    
    Specified by:
    
    sqrt in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    sqrt in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - tan
```
public final Frequency tan()
```
    Set the value(s) to the trigonometric tangent of the value(s).
    
    Specified by:
    
    tan in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    tan in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - tanh
```
public final Frequency tanh()
```
    Set the value(s) to the hyperbolic tangent of the value(s).
    
    Specified by:
    
    tanh in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    tanh in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - inv
```
public final Frequency inv()
```
    Set the value(s) to the complement (1.0/x) of the value(s).
    
    Specified by:
    
    inv in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    inv in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - toDegrees
```
public final Frequency toDegrees()
```
    Set the value(s) to approximately equivalent angle(s) measured in degrees.
    
    Specified by:
    
    toDegrees in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    toDegrees in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - toRadians
```
public final Frequency toRadians()
```
    Set the value(s) to approximately equivalent angle(s) measured in radians.
    
    Specified by:
    
    toRadians in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    toRadians in class DoubleScalar.Rel<FrequencyUnit>
    
    Returns:
    
    T; the modified T
  - pow
```
public final Frequency pow(double x)
```
    Set the value(s) to the value(s) raised to the power of the argument.
    
    Specified by:
    
    pow in interface MathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    pow in class DoubleScalar.Rel<FrequencyUnit>
    
    Parameters:
    
    x - double; the value to use as the power
    
    Returns:
    
    T; the modified T
  - multiplyBy
```
public final Frequency multiplyBy(double factor)
```
    Scale the value(s) by a factor.
    
    Specified by:
    
    multiplyBy in interface DoubleMathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    multiplyBy in class DoubleScalar.Rel<FrequencyUnit>
    
    Parameters:
    
    factor - double; the multiplier
    
    Returns:
    
    T; the modified T
  - divideBy
```
public final Frequency divideBy(double divisor)
```
    Scale the value(s) by the inverse of a factor; i.e. a divisor.
    
    Specified by:
    
    divideBy in interface DoubleMathFunctions<DoubleScalar<FrequencyUnit>>
    
    Overrides:
    
    divideBy in class DoubleScalar.Rel<FrequencyUnit>
    
    Parameters:
    
    divisor - double; the divisor
    
    Returns:
    
    T; the modified T
  - plus
```
public final Frequency plus(Frequency 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 Frequency minus(Frequency 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 Dimensionless.Rel divideBy(Frequency v)
```
    Calculate the division of Frequency and Frequency, which results in a Dimensionless scalar.
    
    Parameters:
    
    v - Frequency scalar
    
    Returns:
    
    Dimensionless scalar as a division of Frequency and Frequency
  - multiplyBy
```
public final Dimensionless.Rel multiplyBy(Time.Rel v)
```
    Calculate the multiplication of Frequency and Time, which results in a Dimensionless scalar.
    
    Parameters:
    
    v - Frequency scalar
    
    Returns:
    
    Dimensionless scalar as a multiplication of Frequency and Time
  - multiplyBy
```
public final Speed multiplyBy(Length.Rel v)
```
    Calculate the multiplication of Frequency and Length, which results in a Speed scalar.
    
    Parameters:
    
    v - Frequency scalar
    
    Returns:
    
    Speed scalar as a multiplication of Frequency and Length
  - multiplyBy
```
public final Acceleration multiplyBy(Speed v)
```
    Calculate the multiplication of Frequency and Speed, which results in a Acceleration scalar.
    
    Parameters:
    
    v - Frequency scalar
    
    Returns:
    
    Acceleration scalar as a multiplication of Frequency and Speed
  - multiplyBy
```
public final Power multiplyBy(Energy v)
```
    Calculate the multiplication of Frequency and Energy, which results in a Power scalar.
    
    Parameters:
    
    v - Frequency scalar
    
    Returns:
    
    Power scalar as a multiplication of Frequency and Energy
  - multiplyBy
```
public final MoneyPerTime multiplyBy(Money v)
```
    Calculate the multiplication of Frequency and Money, which results in a MoneyPerTime scalar.
    
    Parameters:
    
    v - Frequency scalar
    
    Returns:
    
    MoneyPerTime scalar as a multiplication of Frequency and Money

Class Frequency

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

Field Summary

Fields inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Rel

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

Frequency

Frequency

Method Detail

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

divideBy

plus

minus

divideBy

multiplyBy

multiplyBy

multiplyBy

multiplyBy

multiplyBy