MutableFloatVector.Abs (DJUNITS 1.02.01 API)

java.lang.Object
- org.djunits.value.AbstractValue
- - org.djunits.value.vfloat.vector.FloatVector
 - - org.djunits.value.vfloat.vector.MutableFloatVector
 - - org.djunits.value.vfloat.vector.MutableFloatVector.Abs

Type Parameters:

U - Unit the unit for which this Vector will be created

All Implemented Interfaces:

Serializable, Absolute, FunctionsAbs<U,FloatVector.Abs,FloatVector.Rel>, MathFunctions<MutableFloatVector.Abs>, Value, FloatMathFunctions<MutableFloatVector.Abs>, FloatVectorInterface, MutableFloatVectorInterface

Direct Known Subclasses:

MutableFloatLengthVector.Abs, MutableFloatVector.Abs.Dense, MutableFloatVector.Abs.Sparse

Enclosing class:

MutableFloatVector>
```
public abstract static class MutableFloatVector.Abs>
extends MutableFloatVector
implements Absolute, MathFunctions<MutableFloatVector.Abs>, FloatMathFunctions<MutableFloatVector.Abs>, FunctionsAbs<U,FloatVector.Abs,FloatVector.Rel>
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MutableFloatVector.Abs.Dense<U extends Unit<U>>` ABSOLUTE DENSE implementation of MutableFloatVector.
`static class`	`MutableFloatVector.Abs.Sparse<U extends Unit<U>>` ABSOLUTE SPARSE implementation of MutableFloatVector.

Nested classes/interfaces inherited from class org.djunits.value.vfloat.vector.MutableFloatVector
MutableFloatVector.Abs>, MutableFloatVector.Rel>

Field Summary
- Fields inherited from class org.djunits.value.vfloat.vector.FloatVector
  data

Constructor Summary

Constructors
Modifier Constructor and Description

protected Abs(U unit)
Construct a new Absolute MutableFloatVector.

Constructors
Modifier	Constructor and Description
`protected`	`Abs(U unit)` Construct a new Absolute MutableFloatVector.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`MutableFloatVector.Abs<U>`	`abs()` Set the value(s) to their absolute value.
`MutableFloatVector.Abs<U>`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`MutableFloatVector.Abs<U>`	`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.
`MutableFloatVector.Abs<U>`	`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.
`MutableFloatVector.Abs<U>`	`cbrt()` Set the value(s) to the(ir) cube root.
`MutableFloatVector.Abs<U>`	`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.
`abstract MutableFloatVector.Abs<U>`	`copy()` Create a deep copy of this MutableFloatVector.
`MutableFloatVector.Abs<U>`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`MutableFloatVector.Abs<U>`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`MutableFloatVector.Abs<U>`	`decrementBy(FloatVector.Rel<U> decrement)` Decrement the value by the supplied value and return the result.
`MutableFloatVector.Abs<U>`	`divideBy(float constant)` Scale the value(s) by the inverse of a factor; i.e.
`MutableFloatVector.Abs<U>`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`MutableFloatVector.Abs<U>`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`MutableFloatVector.Abs<U>`	`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.
`FloatScalar.Abs<U>`	`get(int index)` Retrieve the value stored at a specified index as a FloatScalar.
`abstract FloatVector.Abs<U>`	`immutable()` Create a immutable version of this MutableFloatVector.
`MutableFloatVector.Abs<U>`	`incrementBy(FloatVector.Rel<U> increment)` Increment the value by the supplied value and return the result.
`MutableFloatVector.Abs<U>`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`MutableFloatVector.Abs<U>`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`MutableFloatVector.Abs<U>`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`MutableFloatVector.Abs<U>`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`FloatVector.Rel<U>`	`minus(FloatVector.Abs<U> rel)` Subtract an Absolute value from this Absolute value for a vector or matrix.
`FloatVector.Abs<U>`	`minus(FloatVector.Rel<U> rel)` Subtract a Relative value from this Absolute value for a vector or matrix.
`MutableFloatVector.Abs<U>`	`multiplyBy(float constant)` Scale the value(s) by a factor.
`abstract MutableFloatVector.Abs<U>`	`mutable()` Create a mutable version of this FloatVector.
`FloatVector.Abs<U>`	`plus(FloatVector.Rel<U> rel)` Add a Relative value to this Absolute value for a vector or matrix.
`MutableFloatVector.Abs<U>`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`MutableFloatVector.Abs<U>`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`MutableFloatVector.Abs<U>`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`MutableFloatVector.Abs<U>`	`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.
`MutableFloatVector.Abs<U>`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`MutableFloatVector.Abs<U>`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`MutableFloatVector.Abs<U>`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`MutableFloatVector.Abs<U>`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`MutableFloatVector.Abs<U>`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`MutableFloatVector.Abs<U>`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`abstract MutableFloatVector.Abs<U>`	`toDense()` Create a dense version of this FloatVector.
`MutableFloatVector.Abs<U>`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.
`abstract MutableFloatVector.Abs<U>`	`toSparse()` Create a sparse version of this FloatVector.

Methods inherited from class org.djunits.value.vfloat.vector.MutableFloatVector
assign, checkCopyOnWrite, decrementByImpl, incrementByImpl, normalize, scaleValueByValue, scaleValueByValue, set, setInUnit, setSI

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector
cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, initializeSparse, initializeSparseMA, initializeSparseMR, safeGet, safeSet, size, toString, toString, toString, toString, zSum

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

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

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface
cardinality, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

- Constructor Detail
 - Abs
```
protected Abs(U unit)
```
 Construct a new Absolute MutableFloatVector.
 
 Parameters:
 
 unit - U; the unit of the new Absolute MutableFloatVector
- Method Detail
 - mutable
```
public abstract MutableFloatVector.Abs mutable()
```
 Create a mutable version of this FloatVector.
 The mutable version is created with a shallow copy of the data and the internal copyOnWrite flag set. The first operation in the mutable version that modifies the data shall trigger a deep copy of the data.
 
 Specified by:
 
 mutable in interface FloatVectorInterface>
 
 Returns:
 
 MutableFloatVector; mutable version of this FloatVector
 - immutable
```
public abstract FloatVector.Abs immutable()
```
 Create a immutable version of this MutableFloatVector.
 
 Specified by:
 
 immutable in interface MutableFloatVectorInterface>
 
 Returns:
 
 FloatVector; mutable version of this MutableFloatVector
 - copy
```
public abstract MutableFloatVector.Abs copy()
```
 Create a deep copy of this MutableFloatVector.
 
 Specified by:
 
 copy in interface MutableFloatVectorInterface>
 
 Returns:
 
 FloatVector; deep copy of this MutableFloatVector
 - toDense
```
public abstract MutableFloatVector.Abs toDense()
```
 Create a dense version of this FloatVector.
 
 Specified by:
 
 toDense in interface FloatVectorInterface>
 
 Specified by:
 
 toDense in interface MutableFloatVectorInterface>
 
 Returns:
 
 MutableFloatVector; dense version of this FloatVector
 - toSparse
```
public abstract MutableFloatVector.Abs toSparse()
```
 Create a sparse version of this FloatVector.
 
 Specified by:
 
 toSparse in interface FloatVectorInterface>
 
 Specified by:
 
 toSparse in interface MutableFloatVectorInterface>
 
 Returns:
 
 MutableFloatVector; sparse version of this FloatVector
 - get
```
public FloatScalar.Abs get(int index)
 throws ValueException
```
 Retrieve the value stored at a specified index as a FloatScalar.
 
 Specified by:
 
 get in interface FloatVectorInterface>
 
 Parameters:
 
 index - int; index of the value to retrieve
 
 Returns:
 
 FloatScalar; the strongly typed value of the selected cell
 
 Throws:
 
 ValueException - when index out of range (index < 0 or index >= size())
 - incrementBy
```
public final MutableFloatVector.Abs incrementBy(FloatVector.Rel increment)
 throws ValueException
```
 Increment the value by the supplied value and return the result.
 
 Parameters:
 
 increment - FloatVector.Rel; amount by which the value is incremented
 
 Returns:
 
 MutableFloatVector.Abs
 
 Throws:
 
 ValueException - when the size of increment is not identical to the size of this
 - decrementBy
```
public final MutableFloatVector.Abs decrementBy(FloatVector.Rel decrement)
 throws ValueException
```
 Decrement the value by the supplied value and return the result.
 
 Parameters:
 
 decrement - FloatVector.Rel; amount by which the value is decremented
 
 Returns:
 
 MutableFloatVector.Abs
 
 Throws:
 
 ValueException - when the size of increment is not identical to the size of this
 - plus
```
public FloatVector.Abs plus(FloatVector.Rel rel)
 throws ValueException
```
 Add a Relative value to this Absolute value for a vector or matrix. The addition is done value by value and the result is stored in a new Absolute value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.
 
 Specified by:
 
 plus in interface FunctionsAbs,FloatVector.Abs>,FloatVector.Rel>>
 
 Parameters:
 
 rel - R the right operand
 
 Returns:
 
 A the sum of this vector and the operand
 
 Throws:
 
 ValueException - in case this vector and the operand have a different size
 - minus
```
public FloatVector.Abs minus(FloatVector.Rel rel)
 throws ValueException
```
 Subtract a Relative value from this Absolute value for a vector or matrix. The subtraction is done value by value and the result is stored in a new Absolute value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.
 
 Specified by:
 
 minus in interface FunctionsAbs,FloatVector.Abs>,FloatVector.Rel>>
 
 Parameters:
 
 rel - R the right operand
 
 Returns:
 
 A the subtraction of this vector and the operand
 
 Throws:
 
 ValueException - in case this vector and the operand have a different size
 - minus
```
public FloatVector.Rel minus(FloatVector.Abs rel)
 throws ValueException
```
 Subtract an Absolute value from this Absolute value for a vector or matrix. The subtraction is done value by value and the result is stored in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.
 
 Specified by:
 
 minus in interface FunctionsAbs,FloatVector.Abs>,FloatVector.Rel>>
 
 Parameters:
 
 rel - A the right operand
 
 Returns:
 
 R the subtraction of this vector and the operand
 
 Throws:
 
 ValueException - in case this vector and the operand have a different size
 - abs
```
public MutableFloatVector.Abs abs()
```
 Set the value(s) to their absolute value.
 
 Specified by:
 
 abs in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - acos
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - asin
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - atan
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - cbrt
```
public MutableFloatVector.Abs cbrt()
```
 Set the value(s) to the(ir) cube root.
 
 Specified by:
 
 cbrt in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - ceil
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - cos
```
public MutableFloatVector.Abs cos()
```
 Set the value(s) to the trigonometric cosine of the value(s).
 
 Specified by:
 
 cos in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - cosh
```
public MutableFloatVector.Abs cosh()
```
 Set the value(s) to the hyperbolic cosine of the value(s).
 
 Specified by:
 
 cosh in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - exp
```
public MutableFloatVector.Abs exp()
```
 Set the value(s) to Euler's number e raised to the power of the value(s).
 
 Specified by:
 
 exp in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - expm1
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - floor
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - log
```
public MutableFloatVector.Abs log()
```
 Set the value(s) to the natural logarithm (base e) of the value(s).
 
 Specified by:
 
 log in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - log10
```
public MutableFloatVector.Abs log10()
```
 Set the value(s) to the base 10 logarithm of the value(s).
 
 Specified by:
 
 log10 in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - log1p
```
public MutableFloatVector.Abs log1p()
```
 Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
 
 Specified by:
 
 log1p in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - pow
```
public MutableFloatVector.Abs pow(double x)
```
 Set the value(s) to the value(s) raised to the power of the argument.
 
 Specified by:
 
 pow in interface MathFunctions<MutableFloatVector.Abs>>
 
 Parameters:
 
 x - double; the value to use as the power
 
 Returns:
 
 T; the modified T
 - rint
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - round
```
public MutableFloatVector.Abs round()
```
 Set the value(s) to the closest long to the argument with ties rounding up.
 
 Specified by:
 
 round in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - signum
```
public MutableFloatVector.Abs 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<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - sin
```
public MutableFloatVector.Abs sin()
```
 Set the value(s) to the trigonometric sine of the value(s).
 
 Specified by:
 
 sin in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - sinh
```
public MutableFloatVector.Abs sinh()
```
 Set the value(s) to the hyperbolic sine of the value(s).
 
 Specified by:
 
 sinh in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - sqrt
```
public MutableFloatVector.Abs sqrt()
```
 Set the value(s) to the correctly rounded positive square root of the value(s).
 
 Specified by:
 
 sqrt in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - tan
```
public MutableFloatVector.Abs tan()
```
 Set the value(s) to the trigonometric tangent of the value(s).
 
 Specified by:
 
 tan in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - tanh
```
public MutableFloatVector.Abs tanh()
```
 Set the value(s) to the hyperbolic tangent of the value(s).
 
 Specified by:
 
 tanh in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - toDegrees
```
public MutableFloatVector.Abs toDegrees()
```
 Set the value(s) to approximately equivalent angle(s) measured in degrees.
 
 Specified by:
 
 toDegrees in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - toRadians
```
public MutableFloatVector.Abs toRadians()
```
 Set the value(s) to approximately equivalent angle(s) measured in radians.
 
 Specified by:
 
 toRadians in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - inv
```
public MutableFloatVector.Abs inv()
```
 Set the value(s) to the complement (1.0/x) of the value(s).
 
 Specified by:
 
 inv in interface MathFunctions<MutableFloatVector.Abs>>
 
 Returns:
 
 T; the modified T
 - multiplyBy
```
public MutableFloatVector.Abs multiplyBy(float constant)
```
 Scale the value(s) by a factor.
 
 Specified by:
 
 multiplyBy in interface FloatMathFunctions<MutableFloatVector.Abs>>
 
 Parameters:
 
 constant - float; the multiplier
 
 Returns:
 
 T; the modified T
 - divideBy
```
public MutableFloatVector.Abs divideBy(float constant)
```
 Scale the value(s) by the inverse of a factor; i.e. a divisor.
 
 Specified by:
 
 divideBy in interface FloatMathFunctions<MutableFloatVector.Abs>>
 
 Parameters:
 
 constant - float; the divisor
 
 Returns:
 
 T; the modified T

Class MutableFloatVector.Abs<U extends Unit<U>>

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.vector.MutableFloatVector

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.FloatVector

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vfloat.vector.MutableFloatVector

Methods inherited from class org.djunits.value.vfloat.vector.FloatVector

Methods inherited from class org.djunits.value.AbstractValue

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.vfloat.vector.FloatVectorInterface

Constructor Detail

Abs

Method Detail

mutable

immutable

copy

toDense

toSparse

get

incrementBy

decrementBy

plus

minus

minus

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

multiplyBy

divideBy