FunctionsRel (DJUNITS 1.02.01 API)

Type Parameters:

U - the Unit type

A - the absolute type

R - the corresponding relative type

All Known Implementing Classes:

AccelerationVector, AccelerationVector.Dense, AccelerationVector.Sparse, AnglePlaneVector.Rel, AnglePlaneVector.Rel.Dense, AnglePlaneVector.Rel.Sparse, AngleSlopeVector.Rel, AngleSlopeVector.Rel.Dense, AngleSlopeVector.Rel.Sparse, AngleSolidVector, AngleSolidVector.Dense, AngleSolidVector.Sparse, AreaVector, AreaVector.Dense, AreaVector.Sparse, DensityVector, DensityVector.Dense, DensityVector.Sparse, DimensionlessVector.Rel, DimensionlessVector.Rel.Dense, DimensionlessVector.Rel.Sparse, DoubleVector.Rel, DoubleVector.Rel.Dense, DoubleVector.Rel.Sparse, ElectricalChargeVector, ElectricalChargeVector.Dense, ElectricalChargeVector.Sparse, ElectricalCurrentVector, ElectricalCurrentVector.Dense, ElectricalCurrentVector.Sparse, ElectricalPotentialVector, ElectricalPotentialVector.Dense, ElectricalPotentialVector.Sparse, ElectricalResistanceVector, ElectricalResistanceVector.Dense, ElectricalResistanceVector.Sparse, EnergyVector, EnergyVector.Dense, EnergyVector.Sparse, FloatAccelerationVector, FloatAccelerationVector.Dense, FloatAccelerationVector.Sparse, FloatLengthVector.Rel, FloatLengthVector.Rel.Dense, FloatLengthVector.Rel.Sparse, FloatVector.Rel, FloatVector.Rel.Dense, FloatVector.Rel.Sparse, FlowMassVector, FlowMassVector.Dense, FlowMassVector.Sparse, FlowVolumeVector, FlowVolumeVector.Dense, FlowVolumeVector.Sparse, ForceVector, ForceVector.Dense, ForceVector.Sparse, FrequencyVector, FrequencyVector.Dense, FrequencyVector.Sparse, LengthVector.Rel, LengthVector.Rel.Dense, LengthVector.Rel.Sparse, LinearDensityVector, LinearDensityVector.Dense, LinearDensityVector.Sparse, MassVector, MassVector.Dense, MassVector.Sparse, MoneyPerAreaVector, MoneyPerAreaVector.Dense, MoneyPerAreaVector.Sparse, MoneyPerEnergyVector, MoneyPerEnergyVector.Dense, MoneyPerEnergyVector.Sparse, MoneyPerLengthVector, MoneyPerLengthVector.Dense, MoneyPerLengthVector.Sparse, MoneyPerMassVector, MoneyPerMassVector.Dense, MoneyPerMassVector.Sparse, MoneyPerTimeVector, MoneyPerTimeVector.Dense, MoneyPerTimeVector.Sparse, MoneyPerVolumeVector, MoneyPerVolumeVector.Dense, MoneyPerVolumeVector.Sparse, MoneyVector, MoneyVector.Dense, MoneyVector.Sparse, MutableAccelerationVector, MutableAccelerationVector.Dense, MutableAccelerationVector.Sparse, MutableAnglePlaneVector.Rel, MutableAnglePlaneVector.Rel.Dense, MutableAnglePlaneVector.Rel.Sparse, MutableAngleSlopeVector.Rel, MutableAngleSlopeVector.Rel.Dense, MutableAngleSlopeVector.Rel.Sparse, MutableAngleSolidVector, MutableAngleSolidVector.Dense, MutableAngleSolidVector.Sparse, MutableAreaVector, MutableAreaVector.Dense, MutableAreaVector.Sparse, MutableDensityVector, MutableDensityVector.Dense, MutableDensityVector.Sparse, MutableDimensionlessVector.Rel, MutableDimensionlessVector.Rel.Dense, MutableDimensionlessVector.Rel.Sparse, MutableDoubleVector.Rel, MutableDoubleVector.Rel.Dense, MutableDoubleVector.Rel.Sparse, MutableElectricalChargeVector, MutableElectricalChargeVector.Dense, MutableElectricalChargeVector.Sparse, MutableElectricalCurrentVector, MutableElectricalCurrentVector.Dense, MutableElectricalCurrentVector.Sparse, MutableElectricalPotentialVector, MutableElectricalPotentialVector.Dense, MutableElectricalPotentialVector.Sparse, MutableElectricalResistanceVector, MutableElectricalResistanceVector.Dense, MutableElectricalResistanceVector.Sparse, MutableEnergyVector, MutableEnergyVector.Dense, MutableEnergyVector.Sparse, MutableFloatAccelerationVector, MutableFloatAccelerationVector.Dense, MutableFloatAccelerationVector.Sparse, MutableFloatLengthVector.Rel, MutableFloatLengthVector.Rel.Dense, MutableFloatLengthVector.Rel.Sparse, MutableFloatVector.Rel, MutableFloatVector.Rel.Dense, MutableFloatVector.Rel.Sparse, MutableFlowMassVector, MutableFlowMassVector.Dense, MutableFlowMassVector.Sparse, MutableFlowVolumeVector, MutableFlowVolumeVector.Dense, MutableFlowVolumeVector.Sparse, MutableForceVector, MutableForceVector.Dense, MutableForceVector.Sparse, MutableFrequencyVector, MutableFrequencyVector.Dense, MutableFrequencyVector.Sparse, MutableLengthVector.Rel, MutableLengthVector.Rel.Dense, MutableLengthVector.Rel.Sparse, MutableLinearDensityVector, MutableLinearDensityVector.Dense, MutableLinearDensityVector.Sparse, MutableMassVector, MutableMassVector.Dense, MutableMassVector.Sparse, MutableMoneyPerAreaVector, MutableMoneyPerAreaVector.Dense, MutableMoneyPerAreaVector.Sparse, MutableMoneyPerEnergyVector, MutableMoneyPerEnergyVector.Dense, MutableMoneyPerEnergyVector.Sparse, MutableMoneyPerLengthVector, MutableMoneyPerLengthVector.Dense, MutableMoneyPerLengthVector.Sparse, MutableMoneyPerMassVector, MutableMoneyPerMassVector.Dense, MutableMoneyPerMassVector.Sparse, MutableMoneyPerTimeVector, MutableMoneyPerTimeVector.Dense, MutableMoneyPerTimeVector.Sparse, MutableMoneyPerVolumeVector, MutableMoneyPerVolumeVector.Dense, MutableMoneyPerVolumeVector.Sparse, MutableMoneyVector, MutableMoneyVector.Dense, MutableMoneyVector.Sparse, MutablePowerVector, MutablePowerVector.Dense, MutablePowerVector.Sparse, MutablePressureVector, MutablePressureVector.Dense, MutablePressureVector.Sparse, MutableSpeedVector, MutableSpeedVector.Dense, MutableSpeedVector.Sparse, MutableTemperatureVector.Rel, MutableTemperatureVector.Rel.Dense, MutableTemperatureVector.Rel.Sparse, MutableTimeVector.Rel, MutableTimeVector.Rel.Dense, MutableTimeVector.Rel.Sparse, MutableTorqueVector, MutableTorqueVector.Dense, MutableTorqueVector.Sparse, MutableVolumeVector, MutableVolumeVector.Dense, MutableVolumeVector.Sparse, PowerVector, PowerVector.Dense, PowerVector.Sparse, PressureVector, PressureVector.Dense, PressureVector.Sparse, SpeedVector, SpeedVector.Dense, SpeedVector.Sparse, TemperatureVector.Rel, TemperatureVector.Rel.Dense, TemperatureVector.Rel.Sparse, TimeVector.Rel, TimeVector.Rel.Dense, TimeVector.Rel.Sparse, TorqueVector, TorqueVector.Dense, TorqueVector.Sparse, VolumeVector, VolumeVector.Dense, VolumeVector.Sparse
```
public interface FunctionsRel<U extends Unit<U>,A extends Absolute & Value<U>,R extends Relative & Value<U>>
```
The functions to be implemented for relative vectors and matrices.
Copyright (c) 2013-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-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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`R`	`divide(R rel)` Divide this Relative value by a Relative value for a vector or matrix.
`R`	`minus(R rel)` Subtract a Relative value from this Relative value for a vector or matrix.
`A`	`plus(A abs)` Add an Absolute value to this Relative value for a vector or matrix.
`R`	`plus(R rel)` Add a Relative value to this Relative value for a vector or matrix.
`R`	`times(R rel)` Multiply a Relative value by this Relative value for a vector or matrix.

- Method Detail
  - plus
```
R plus(R rel)
throws ValueException
```
    Add a Relative value to this Relative value for a vector or matrix. The addition 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:
    
    rel - R the right operand
    
    Returns:
    
    A the sum of this vector and the operand
    
    Throws:
    
    ValueException - in case this vector or matrix and the operand have a different size
  - plus
```
A plus(A abs)
throws ValueException
```
    Add an Absolute value to this Relative 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:
    
    abs - A the right operand
    
    Returns:
    
    A the sum of this vector and the operand
    
    Throws:
    
    ValueException - in case this vector or matrix and the operand have a different size
  - minus
```
R minus(R rel)
 throws ValueException
```
    Subtract a Relative value from this Relative 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:
    
    rel - R the right operand
    
    Returns:
    
    A the sum of this vector and the operand
    
    Throws:
    
    ValueException - in case this vector or matrix and the operand have a different size
  - times
```
R times(R rel)
 throws ValueException
```
    Multiply a Relative value by this Relative value for a vector or matrix. The multiplication is done value by value and the result is stored in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse 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 or matrix and the operand have a different size
  - divide
```
R divide(R rel)
  throws ValueException
```
    Divide this Relative value by a Relative value for a vector or matrix. The division is done value by value and the result is stored in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse 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 or matrix and the operand have a different size

Interface FunctionsRel<U extends Unit<U>,A extends Absolute & Value<U>,R extends Relative & Value<U>>

Method Summary

Method Detail

plus

plus

minus

times

divide