MathFunctions (Open Traffic Sim core classes 0.02.02 API)

Type Parameters:

T - the type of the value that the functions operate on

All Superinterfaces:

Serializable

All Known Subinterfaces:

DoubleMathFunctions<T>, FloatMathFunctions<T>

All Known Implementing Classes:

MutableDoubleMatrix, MutableDoubleMatrix.Abs, MutableDoubleMatrix.Abs.Dense, MutableDoubleMatrix.Abs.Sparse, MutableDoubleMatrix.Rel, MutableDoubleMatrix.Rel.Dense, MutableDoubleMatrix.Rel.Sparse, MutableDoubleScalar, MutableDoubleScalar.Abs, MutableDoubleScalar.Rel, MutableDoubleVector, MutableDoubleVector.Abs, MutableDoubleVector.Abs.Dense, MutableDoubleVector.Abs.Sparse, MutableDoubleVector.Rel, MutableDoubleVector.Rel.Dense, MutableDoubleVector.Rel.Sparse, MutableFloatMatrix, MutableFloatMatrix.Abs, MutableFloatMatrix.Abs.Dense, MutableFloatMatrix.Abs.Sparse, MutableFloatMatrix.Rel, MutableFloatMatrix.Rel.Dense, MutableFloatMatrix.Rel.Sparse, MutableFloatScalar, MutableFloatScalar.Abs, MutableFloatScalar.Rel, MutableFloatVector, MutableFloatVector.Abs, MutableFloatVector.Abs.Dense, MutableFloatVector.Abs.Sparse, MutableFloatVector.Rel, MutableFloatVector.Rel.Dense, MutableFloatVector.Rel.Sparse
```
public interface MathFunctions<T>
extends Serializable
```
Interface to force all functions of Math to be implemented.
This file was generated by the OpenTrafficSim value classes generator, 26 jun, 2015
Copyright (c) 2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`abs()` Set the value(s) to their absolute value.
`T`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`T`	`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.
`T`	`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.
`T`	`cbrt()` Set the value(s) to the(ir) cube root.
`T`	`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.
`T`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`T`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`T`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`T`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`T`	`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.
`T`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`T`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`T`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`T`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`T`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`T`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`T`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`T`	`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.
`T`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`T`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`T`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`T`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`T`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`T`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`T`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

- Method Detail
  - abs
```
T abs()
```
    Set the value(s) to their absolute value.
    
    Returns:
    
    T; the modified T
  - acos
```
T acos()
```
    Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
    
    Returns:
    
    T; the modified T
  - asin
```
T 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.
    
    Returns:
    
    T; the modified T
  - atan
```
T 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.
    
    Returns:
    
    T; the modified T
  - cbrt
```
T cbrt()
```
    Set the value(s) to the(ir) cube root.
    
    Returns:
    
    T; the modified T
  - ceil
```
T 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.
    
    Returns:
    
    T; the modified T
  - cos
```
T cos()
```
    Set the value(s) to the trigonometric cosine of the value(s).
    
    Returns:
    
    T; the modified T
  - cosh
```
T cosh()
```
    Set the value(s) to the hyperbolic cosine of the value(s).
    
    Returns:
    
    T; the modified T
  - exp
```
T exp()
```
    Set the value(s) to Euler's number e raised to the power of the value(s).
    
    Returns:
    
    T; the modified T
  - expm1
```
T expm1()
```
    Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
    
    Returns:
    
    T; the modified T
  - floor
```
T 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.
    
    Returns:
    
    T; the modified T
  - log
```
T log()
```
    Set the value(s) to the natural logarithm (base e) of the value(s).
    
    Returns:
    
    T; the modified T
  - log10
```
T log10()
```
    Set the value(s) to the base 10 logarithm of the value(s).
    
    Returns:
    
    T; the modified T
  - log1p
```
T log1p()
```
    Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
    
    Returns:
    
    T; the modified T
  - pow
```
T pow(double x)
```
    Set the value(s) to the value(s) raised to the power of the argument.
    
    Parameters:
    
    x - double; the value to use as the power
    
    Returns:
    
    T; the modified T
  - rint
```
T rint()
```
    Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
    
    Returns:
    
    T; the modified T
  - round
```
T round()
```
    Set the value(s) to the closest long to the argument with ties rounding up.
    
    Returns:
    
    T; the modified T
  - signum
```
T 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.
    
    Returns:
    
    T; the modified T
  - sin
```
T sin()
```
    Set the value(s) to the trigonometric sine of the value(s).
    
    Returns:
    
    T; the modified T
  - sinh
```
T sinh()
```
    Set the value(s) to the hyperbolic sine of the value(s).
    
    Returns:
    
    T; the modified T
  - sqrt
```
T sqrt()
```
    Set the value(s) to the correctly rounded positive square root of the value(s).
    
    Returns:
    
    T; the modified T
  - tan
```
T tan()
```
    Set the value(s) to the trigonometric tangent of the value(s).
    
    Returns:
    
    T; the modified T
  - tanh
```
T tanh()
```
    Set the value(s) to the hyperbolic tangent of the value(s).
    
    Returns:
    
    T; the modified T
  - toDegrees
```
T toDegrees()
```
    Set the value(s) to approximately equivalent angle(s) measured in degrees.
    
    Returns:
    
    T; the modified T
  - toRadians
```
T toRadians()
```
    Set the value(s) to approximately equivalent angle(s) measured in radians.
    
    Returns:
    
    T; the modified T
  - inv
```
T inv()
```
    Set the value(s) to the complement (1.0/x) of the value(s).
    
    Returns:
    
    T; the modified T

Interface MathFunctions<T>

Method Summary

Method Detail

abs

acos

asin

atan

cbrt

ceil

cos

cosh

exp

expm1

floor

log

log10

log1p

pow

rint

round

signum

sin

sinh

sqrt

tan

tanh

toDegrees

toRadians

inv