org.djunits.value

Interface FunctionsAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends Absolute & Value<AU>,R extends Relative & Value<RU>>

Type Parameters:

AU - Absolute unit

RU - Relative unit

A - the absolute type

R - the corresponding relative type

All Known Implementing Classes:

AbsoluteTemperatureMatrix, AbsoluteTemperatureVector, AbstractDoubleMatrixAbs, AbstractDoubleVectorAbs, AbstractFloatMatrixAbs, AbstractFloatVectorAbs, AbstractMutableDoubleMatrixAbs, AbstractMutableDoubleVectorAbs, AbstractMutableFloatMatrixAbs, AbstractMutableFloatVectorAbs, DirectionMatrix, DirectionVector, DoubleMatrix.Abs, DoubleVector.Abs, FloatAbsoluteTemperatureMatrix, FloatAbsoluteTemperatureVector, FloatDirectionMatrix, FloatDirectionVector, FloatMatrix.Abs, FloatPositionMatrix, FloatPositionVector, FloatTimeMatrix, FloatTimeVector, FloatVector.Abs, MutableAbsoluteTemperatureMatrix, MutableAbsoluteTemperatureVector, MutableDirectionMatrix, MutableDirectionVector, MutableDoubleMatrix.Abs, MutableDoubleVector.Abs, MutableFloatAbsoluteTemperatureMatrix, MutableFloatAbsoluteTemperatureVector, MutableFloatDirectionMatrix, MutableFloatDirectionVector, MutableFloatMatrix.Abs, MutableFloatPositionMatrix, MutableFloatPositionVector, MutableFloatTimeMatrix, MutableFloatTimeVector, MutableFloatVector.Abs, MutablePositionMatrix, MutablePositionVector, MutableTimeMatrix, MutableTimeVector, PositionMatrix, PositionVector, TimeMatrix, TimeVector

public interface FunctionsAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends Absolute & Value<AU>,R extends Relative & Value<RU>>

The functions to be implemented for absolute vectors and matrices.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 6, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
R	minus(A abs) Subtract an Absolute value from this Absolute value for a vector or matrix.
A	minus(R rel) Subtract a Relative value from this Absolute value for a vector or matrix.
A	plus(R rel) Add a Relative value to this Absolute value for a vector or matrix.

Method Detail

plus

A plus(R 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.

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

A minus(R 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.

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

R minus(A abs)
 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.

Parameters:

abs - 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