org.opentrafficsim.core.value.vfloat.scalar

Class MutableFloatScalar<U extends Unit<U>>

java.lang.Object

java.lang.Number

org.opentrafficsim.core.value.Scalar<U>

org.opentrafficsim.core.value.vfloat.scalar.FloatScalar<U>

org.opentrafficsim.core.value.vfloat.scalar.MutableFloatScalar<U>

Type Parameters:

U - Unit; the unit of this MutableFloatScalar

All Implemented Interfaces:

Serializable, MathFunctions<FloatScalar<U>>, Value<U>, FloatMathFunctions<FloatScalar<U>>

Direct Known Subclasses:

MutableFloatScalar.Abs, MutableFloatScalar.Rel

public abstract class MutableFloatScalar<U extends Unit<U>>
extends FloatScalar<U>
implements FloatMathFunctions<FloatScalar<U>>

MutableFloatScalar.

This file was generated by the OpenTrafficSim value classes generator, 09 mrt, 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:

09 mrt, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MutableFloatScalar.Abs<U extends Unit<U>>
static class	MutableFloatScalar.Rel<U extends Unit<U>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutableFloatScalar(U unit) Construct a new MutableFloatScalar.

Method Summary

Methods

Modifier and Type	Method and Description
protected MutableFloatScalar<U>	decrementBy(FloatScalar<U> decrement) Decrement the value in this MutableFloatScalar by the value in a FloatScalar.
protected MutableFloatScalar<U>	decrementByImpl(FloatScalar.Rel<U> rel) Decrement the value of this Relative FloatScalar from the value of this MutableFloatScalar.
MutableFloatScalar<U>	divide(float constant) Scale the value(s) by the inverse of a factor; i.e.
abstract FloatScalar<U>	immutable() Make (immutable) FloatScalar equivalent for any type of MutableFloatScalar.
protected MutableFloatScalar<U>	incrementBy(FloatScalar<U> increment) Increment the value in this MutableFloatScalar by the value in a FloatScalar.
protected MutableFloatScalar<U>	incrementByImpl(FloatScalar.Rel<U> rel) Increment the value in this MutableFloatScalar by the value in a Relative FloatScalar.
MutableFloatScalar<U>	multiply(float constant) Scale the value(s) by a factor.

Methods inherited from class org.opentrafficsim.core.value.vfloat.scalar.FloatScalar

divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, getSI, hashCode, initialize, initialize, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, mutable, plus, plus, setValueSI, toString, toString, toString, toString

Methods inherited from class org.opentrafficsim.core.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

Methods inherited from interface org.opentrafficsim.core.value.MathFunctions

abs, acos, asin, atan, cbrt, ceil, cos, cosh, exp, expm1, floor, inv, log, log10, log1p, pow, rint, round, signum, sin, sinh, sqrt, tan, tanh, toDegrees, toRadians

Methods inherited from interface org.opentrafficsim.core.value.Value

copy

Constructor Detail

MutableFloatScalar

protected MutableFloatScalar(U unit)

Construct a new MutableFloatScalar.

Parameters:

unit - U; the unit of the new MutableFloatScalar

Method Detail

immutable

public abstract FloatScalar<U> immutable()

Make (immutable) FloatScalar equivalent for any type of MutableFloatScalar.
The immutable version is created as a deep copy of this. Delayed copying is not worthwhile for a Scalar.

Returns:

FloatScalar<U>; immutable version of this FloatScalar

multiply

public final MutableFloatScalar<U> multiply(float constant)

Scale the value(s) by a factor.

Specified by:

multiply in interface FloatMathFunctions<FloatScalar<U extends Unit<U>>>

Parameters:

constant - float; the multiplier

Returns:

T; the modified T

divide

public final MutableFloatScalar<U> divide(float constant)

Scale the value(s) by the inverse of a factor; i.e. a divisor.

Specified by:

divide in interface FloatMathFunctions<FloatScalar<U extends Unit<U>>>

Parameters:

constant - float; the divisor

Returns:

T; the modified T

incrementBy

protected final MutableFloatScalar<U> incrementBy(FloatScalar<U> increment)

Increment the value in this MutableFloatScalar by the value in a FloatScalar.

Parameters:

increment - FloatScalar<U>; the amount by which to increment the value in this MutableFloatScalar

Returns:

MutableFloatScalar<U>; this modified MutableFloatScalar

decrementBy

protected final MutableFloatScalar<U> decrementBy(FloatScalar<U> decrement)

Decrement the value in this MutableFloatScalar by the value in a FloatScalar.

Parameters:

decrement - FloatScalar<U>; the amount by which to decrement the value in this MutableFloatScalar

Returns:

MutableFloatScalar<U>; this modified MutableFloatScalar

incrementByImpl

protected final MutableFloatScalar<U> incrementByImpl(FloatScalar.Rel<U> rel)

Increment the value in this MutableFloatScalar by the value in a Relative FloatScalar.
Only Relative values are allowed; adding an Absolute value to an Absolute value is not allowed. Adding an Absolute value to an existing Relative value would require the result to become Absolute, which is a type change that is impossible. For that operation use a static method.

Parameters:

rel - FloatScalar.Rel<U>; the Relative FloatScalar

Returns:

MutableFloatScalar<U>; this modified MutableFloatScalar

decrementByImpl

protected final MutableFloatScalar<U> decrementByImpl(FloatScalar.Rel<U> rel)

Decrement the value of this Relative FloatScalar from the value of this MutableFloatScalar.
Only Relative values are allowed; subtracting an Absolute value from a Relative value is not allowed. Subtracting an Absolute value from an existing Absolute value would require the result to become Relative, which is a type change that is impossible. For that operation use a static method.

Parameters:

rel - FloatScalar.Rel<U>; the Relative FloatScalar

Returns:

MutableFloatScalar<U>; this modified MutableFloatScalar