org.opentrafficsim.core.value.vdouble.scalar

Class MutableDoubleScalar<U extends Unit<U>>

java.lang.Object

java.lang.Number

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

org.opentrafficsim.core.value.vdouble.scalar.DoubleScalar<U>

org.opentrafficsim.core.value.vdouble.scalar.MutableDoubleScalar<U>

Type Parameters:

U - Unit; the unit of this MutableDoubleScalar

All Implemented Interfaces:

Serializable, MathFunctions<DoubleScalar<U>>, Value<U>, DoubleMathFunctions<DoubleScalar<U>>

Direct Known Subclasses:

MutableDoubleScalar.Abs, MutableDoubleScalar.Rel

public abstract class MutableDoubleScalar<U extends Unit<U>>
extends DoubleScalar<U>
implements DoubleMathFunctions<DoubleScalar<U>>

MutableDoubleScalar.

This file was generated by the OpenTrafficSim value classes generator, 26 jun, 2015

Copyright (c) 2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: averbraeck $, initial version 26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected MutableDoubleScalar<U>	decrementBy(DoubleScalar<U> decrement) Decrement the value in this MutableDoubleScalar by the value in a DoubleScalar.
protected MutableDoubleScalar<U>	decrementByImpl(DoubleScalar.Rel<U> rel) Decrement the value of this Relative DoubleScalar from the value of this MutableDoubleScalar.
abstract DoubleScalar<U>	immutable() Make (immutable) DoubleScalar equivalent for any type of MutableDoubleScalar.
protected MutableDoubleScalar<U>	incrementBy(DoubleScalar<U> increment) Increment the value in this MutableDoubleScalar by the value in a DoubleScalar.
protected MutableDoubleScalar<U>	incrementByImpl(DoubleScalar.Rel<U> rel) Increment the value in this MutableDoubleScalar by the value in a Relative DoubleScalar.

Methods inherited from class org.opentrafficsim.core.value.vdouble.scalar.DoubleScalar

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.vdouble.DoubleMathFunctions

divideBy, multiplyBy

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

MutableDoubleScalar

protected MutableDoubleScalar(U unit)

Construct a new MutableDoubleScalar.

Parameters:

unit - U; the unit of the new MutableDoubleScalar

Method Detail

immutable

public abstract DoubleScalar<U> immutable()

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

Returns:

DoubleScalar<U>; immutable version of this DoubleScalar

incrementBy

protected final MutableDoubleScalar<U> incrementBy(DoubleScalar<U> increment)

Increment the value in this MutableDoubleScalar by the value in a DoubleScalar.

Parameters:

increment - DoubleScalar<U>; the amount by which to increment the value in this MutableDoubleScalar

Returns:

MutableDoubleScalar<U>; this modified MutableDoubleScalar

decrementBy

protected final MutableDoubleScalar<U> decrementBy(DoubleScalar<U> decrement)

Decrement the value in this MutableDoubleScalar by the value in a DoubleScalar.

Parameters:

decrement - DoubleScalar<U>; the amount by which to decrement the value in this MutableDoubleScalar

Returns:

MutableDoubleScalar<U>; this modified MutableDoubleScalar

incrementByImpl

protected final MutableDoubleScalar<U> incrementByImpl(DoubleScalar.Rel<U> rel)

Increment the value in this MutableDoubleScalar by the value in a Relative DoubleScalar.
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 - DoubleScalar.Rel<U>; the Relative DoubleScalar

Returns:

MutableDoubleScalar<U>; this modified MutableDoubleScalar

decrementByImpl

protected final MutableDoubleScalar<U> decrementByImpl(DoubleScalar.Rel<U> rel)

Decrement the value of this Relative DoubleScalar from the value of this MutableDoubleScalar.
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 - DoubleScalar.Rel<U>; the Relative DoubleScalar

Returns:

MutableDoubleScalar<U>; this modified MutableDoubleScalar