org.djunits.value.vdouble.vector

Interface DoubleVectorInterface<U extends Unit<U>>

Type Parameters:

U - the unit

All Known Subinterfaces:

MutableDoubleVectorInterface<U>

All Known Implementing Classes:

AbsoluteTemperatureVector, AbstractDoubleVector, AbstractDoubleVectorAbs, AbstractDoubleVectorRel, AbstractMutableDoubleVectorAbs, AbstractMutableDoubleVectorRel, AccelerationVector, AngleSolidVector, AngleVector, AreaVector, DensityVector, DimensionlessVector, DirectionVector, DoubleVector.Abs, DoubleVector.Rel, DurationVector, ElectricalChargeVector, ElectricalCurrentVector, ElectricalPotentialVector, ElectricalResistanceVector, EnergyVector, FlowMassVector, FlowVolumeVector, ForceVector, FrequencyVector, LengthVector, LinearDensityVector, MassVector, MoneyPerAreaVector, MoneyPerDurationVector, MoneyPerEnergyVector, MoneyPerLengthVector, MoneyPerMassVector, MoneyPerVolumeVector, MoneyVector, MutableAbsoluteTemperatureVector, MutableAccelerationVector, MutableAngleSolidVector, MutableAngleVector, MutableAreaVector, MutableDensityVector, MutableDimensionlessVector, MutableDirectionVector, MutableDoubleVector.Abs, MutableDoubleVector.Rel, MutableDurationVector, MutableElectricalChargeVector, MutableElectricalCurrentVector, MutableElectricalPotentialVector, MutableElectricalResistanceVector, MutableEnergyVector, MutableFlowMassVector, MutableFlowVolumeVector, MutableForceVector, MutableFrequencyVector, MutableLengthVector, MutableLinearDensityVector, MutableMassVector, MutableMoneyPerAreaVector, MutableMoneyPerDurationVector, MutableMoneyPerEnergyVector, MutableMoneyPerLengthVector, MutableMoneyPerMassVector, MutableMoneyPerVolumeVector, MutableMoneyVector, MutablePositionVector, MutablePowerVector, MutablePressureVector, MutableSpeedVector, MutableTemperatureVector, MutableTimeVector, MutableTorqueVector, MutableVolumeVector, PositionVector, PowerVector, PressureVector, SpeedVector, TemperatureVector, TimeVector, TorqueVector, VolumeVector

public interface DoubleVectorInterface<U extends Unit<U>>

Interface for the Immutable and Mutable DoubleVector classes.

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
int	cardinality() Count the number of cells that have a non-zero value (ignores tolerance).
AbstractDoubleScalar<U,?>	get(int index) Retrieve a value from the vector.
double	getInUnit(int index) Retrieve the value stored at a specified position in the original unit.
double	getInUnit(int index, U targetUnit) Retrieve the value stored at a specified position converted into a specified unit.
double	getSI(int index) Retrieve the value stored at a specified position in the standard SI unit.
double[]	getValuesInUnit() Create a double[] array filled with the values in the original unit.
double[]	getValuesInUnit(U targetUnit) Create a double[] array filled with the values converted into a specified unit.
double[]	getValuesSI() Create a double[] array filled with the values in the standard SI unit.
MutableDoubleVectorInterface<U>	mutable() return a mutable version of this vector.
int	size() Retrieve the size of the vector.
DoubleVectorInterface<U>	toDense() return a dense version of this vector.
DoubleVectorInterface<U>	toSparse() return a sparse version of this vector.
String	toString()
String	toString(boolean verbose, boolean withUnit) Print this DoubleVector with optional type and unit information.
String	toString(U displayUnit) Print this DoubleVector with the values expressed in the specified unit.
String	toString(U displayUnit, boolean verbose, boolean withUnit) Print this DoubleVector with the values expressed in the specified unit.
double	zSum() Compute the sum of all values of this vector.

Method Detail

size

int size()

Retrieve the size of the vector.

Returns:

int; the size of the vector

cardinality

int cardinality()

Count the number of cells that have a non-zero value (ignores tolerance).

Returns:

int; the number of cells having non-zero value

get

AbstractDoubleScalar<U,?> get(int index)
                       throws ValueException

Retrieve a value from the vector.

Parameters:

index - the index to retrieve the value at

Returns:

the value as a DoubleScalar

Throws:

ValueException - in case index is out of bounds

getSI

double getSI(int index)
      throws ValueException

Retrieve the value stored at a specified position in the standard SI unit.

Parameters:

index - int; index of the value to retrieve

Returns:

double; value at position index in the standard SI unit

Throws:

ValueException - when index out of range (index < 0 or index >= size())

getInUnit

double getInUnit(int index)
          throws ValueException

Retrieve the value stored at a specified position in the original unit.

Parameters:

index - int; index of the value to retrieve

Returns:

double; value at position index in the original unit

Throws:

ValueException - when index out of range (index < 0 or index >= size())

getInUnit

double getInUnit(int index,
                 U targetUnit)
          throws ValueException

Retrieve the value stored at a specified position converted into a specified unit.

Parameters:

index - int; index of the value to retrieve

targetUnit - U; the unit for the result

Returns:

double; value at position index converted into the specified unit

Throws:

ValueException - when index out of range (index < 0 or index >= size())

mutable

MutableDoubleVectorInterface<U> mutable()

return a mutable version of this vector.

Returns:

a mutable version of this vector

toSparse

DoubleVectorInterface<U> toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toDense

DoubleVectorInterface<U> toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

zSum

double zSum()

Compute the sum of all values of this vector.

Returns:

double; the sum of all values of this vector

getValuesSI

double[] getValuesSI()

Create a double[] array filled with the values in the standard SI unit.

Returns:

double[]; array of values in the standard SI unit

getValuesInUnit

double[] getValuesInUnit()

Create a double[] array filled with the values in the original unit.

Returns:

double[]; the values in the original unit

getValuesInUnit

double[] getValuesInUnit(U targetUnit)

Create a double[] array filled with the values converted into a specified unit.

Parameters:

targetUnit - U; the unit into which the values are converted for use

Returns:

double[]; the values converted into the specified unit

toString

String toString()

Overrides:

toString in class Object

Returns:

a String with the Vector, non-verbose, with the unit attached.

toString

String toString(U displayUnit)

Print this DoubleVector with the values expressed in the specified unit.

Parameters:

displayUnit - U; the unit into which the values are converted for display

Returns:

String; printable string with the vector contents expressed in the specified unit

toString

String toString(boolean verbose,
                boolean withUnit)

Print this DoubleVector with optional type and unit information.

Parameters:

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the vector contents

toString

String toString(U displayUnit,
                boolean verbose,
                boolean withUnit)

Print this DoubleVector with the values expressed in the specified unit.

Parameters:

displayUnit - U; the unit into which the values are converted for display

verbose - boolean; if true; include type info; if false; exclude type info

withUnit - boolean; if true; include the unit; of false; exclude the unit

Returns:

String; printable string with the vector contents