org.djunits.value.vdouble.vector

Class AbstractDoubleVectorAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractDoubleVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractDoubleVectorRel<RU,R,?,?>,MA extends AbstractMutableDoubleVectorAbs<AU,RU,A,R,MA,S>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<AU,A>

org.djunits.value.vdouble.vector.AbstractDoubleVectorAbs<AU,RU,A,R,MA,S>

Type Parameters:

AU - the absolute unit

RU - the relative unit

A - the absolute vector type

R - the relative vector type

MA - the mutable absolute vector type

S - the absolute scalar type

All Implemented Interfaces:

Serializable, Iterable<S>, Absolute, FunctionsAbs<AU,RU,A,R>, Value<AU>, DoubleVectorInterface<AU>

Direct Known Subclasses:

AbsoluteTemperatureVector, AbstractMutableDoubleVectorAbs, DirectionVector, DoubleVector.Abs, PositionVector, TimeVector

abstract class AbstractDoubleVectorAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractDoubleVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractDoubleVectorRel<RU,R,?,?>,MA extends AbstractMutableDoubleVectorAbs<AU,RU,A,R,MA,S>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>>
extends AbstractDoubleVector<AU,A>
implements FunctionsAbs<AU,RU,A,R>, Absolute, Serializable, Iterable<S>

Absolute Immutable typed vector.

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

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDoubleVectorAbs.Itr The iterator class is loosely based in AbstractList.Itr.

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

data

Constructor Summary

Constructors

Constructor and Description
AbstractDoubleVectorAbs(double[] values, AU unit, StorageType storageType) Construct a new Absolute Immutable DoubleVector.
AbstractDoubleVectorAbs(DoubleVectorData data, AU unit) Construct a new Relative Immutable DoubleVector.
AbstractDoubleVectorAbs(List<Double> values, AU unit, StorageType storageType) Construct a new Absolute Immutable DoubleVector.
AbstractDoubleVectorAbs(List<S> values, StorageType storageType) Construct a new Absolute Immutable DoubleVector.
AbstractDoubleVectorAbs(S[] values, StorageType storageType) Construct a new Absolute Immutable DoubleVector.
AbstractDoubleVectorAbs(SortedMap<Integer,Double> values, AU unit, int length, StorageType storageType) Construct a new Absolute Immutable DoubleVector.
AbstractDoubleVectorAbs(SortedMap<Integer,S> values, int length, StorageType storageType) Construct a new Absolute Immutable DoubleVector.

Method Summary

Modifier and Type	Method and Description
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>> AU	checkUnit(List<S> dsList) Check that a provided list can be used to create some descendant of a DoubleVector, and return the Unit.
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>> AU	checkUnit(S[] dsArray) Check that a provided array can be used to create some descendant of a DoubleVector, and return the Unit.
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>> AU	checkUnit(SortedMap<Integer,S> dsMap) Check that a provided Map can be used to create some descendant of a DoubleVector.
S	get(int index) Retrieve a value from the vector.
protected abstract MA	instantiateMutableType(DoubleVectorData dvd, AU unit) Construct a new Absolute Mutable DoubleVector of the right type.
protected abstract S	instantiateScalar(double value, AU unit) Construct a new Absolute Immutable DoubleScalar of the right type.
protected abstract A	instantiateTypeAbs(DoubleVectorData dvd, AU unit) Construct a new Absolute Immutable DoubleVector of the right type.
protected abstract R	instantiateTypeRel(DoubleVectorData dvd, RU unit) Construct a new Relative Immutable DoubleVector of the right type.
Iterator<S>	iterator() Returns an iterator over the scalars in this vector in proper sequence.
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.
MA	mutable() Create a mutable version of this DoubleVector.
A	plus(R rel) Add a Relative value to this Absolute value for a vector or matrix.

Methods inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVector

cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getStorageType, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.value.vdouble.vector.DoubleVectorInterface

toDense, toSparse

Constructor Detail

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(double[] values,
                        AU unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Absolute Immutable DoubleVector.

Parameters:

values - double[]; the values of the entries in the new Absolute Immutable DoubleVector

unit - AU; the unit of the new Absolute Immutable DoubleVector

storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(List<Double> values,
                        AU unit,
                        StorageType storageType)
                 throws ValueException

Construct a new Absolute Immutable DoubleVector.

Parameters:

values - List<Double>; the values of the entries in the new Absolute Immutable DoubleVector

unit - AU; the unit of the new Absolute Immutable DoubleVector

storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(S[] values,
                        StorageType storageType)
                 throws ValueException

Construct a new Absolute Immutable DoubleVector.

Parameters:

values - S[]; the values of the entries in the new Absolute Immutable DoubleVector

storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(List<S> values,
                        StorageType storageType)
                 throws ValueException

Construct a new Absolute Immutable DoubleVector.

Parameters:

values - List<S>; the values of the entries in the new Absolute Immutable DoubleVector

storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(SortedMap<Integer,S> values,
                        int length,
                        StorageType storageType)
                 throws ValueException

Construct a new Absolute Immutable DoubleVector.

Parameters:

values - SortedMap<Integer, S>; the values of the entries in the new Absolute Sparse Mutable DoubleVector

length - int; the size of the vector

storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values has zero entries

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(SortedMap<Integer,Double> values,
                        AU unit,
                        int length,
                        StorageType storageType)
                 throws ValueException

Construct a new Absolute Immutable DoubleVector.

Parameters:

values - SortedMap<Integer, Double>; the map of indexes to values of the Absolute Sparse Mutable DoubleVector

unit - AU; the unit of the new Absolute Sparse Mutable DoubleVector

length - int; the size of the vector

storageType - StorageType; the data type to use (e.g., DENSE or SPARSE)

Throws:

ValueException - when values is null

AbstractDoubleVectorAbs

AbstractDoubleVectorAbs(DoubleVectorData data,
                        AU unit)

Construct a new Relative Immutable DoubleVector.

Parameters:

data - DoubleVectorData; an internal data object

unit - AU; the unit

Method Detail

mutable

public MA mutable()

Create a mutable version of this DoubleVector.
The mutable version is created with a shallow copy of the data and the internal copyOnWrite flag set. The first operation in the mutable version that modifies the data shall trigger a deep copy of the data.

Specified by:

mutable in interface DoubleVectorInterface<AU extends AbsoluteLinearUnit<AU,RU>>

Returns:

MA; mutable version of this DoubleVector

instantiateTypeAbs

protected abstract A instantiateTypeAbs(DoubleVectorData dvd,
                                        AU unit)

Construct a new Absolute Immutable DoubleVector of the right type. Each extending class must implement this method.

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateTypeRel

protected abstract R instantiateTypeRel(DoubleVectorData dvd,
                                        RU unit)

Construct a new Relative Immutable DoubleVector of the right type. Each extending class must implement this method.

Parameters:

dvd - DoubleVectorData; an internal data object

unit - RU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateMutableType

protected abstract MA instantiateMutableType(DoubleVectorData dvd,
                                             AU unit)

Construct a new Absolute Mutable DoubleVector of the right type. Each extending class must implement this method.

Parameters:

dvd - DoubleVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable DoubleVector of the right type

instantiateScalar

protected abstract S instantiateScalar(double value,
                                       AU unit)

Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.

Parameters:

value - double; the value

unit - AU; the unit

Returns:

S the Immutable DoubleScalar of the right type

get

public final S get(int index)
            throws ValueException

Retrieve a value from the vector.

Specified by:

get in interface DoubleVectorInterface<AU extends AbsoluteLinearUnit<AU,RU>>

Parameters:

index - int; the index to retrieve the value at

Returns:

the value as a DoubleScalar

Throws:

ValueException - in case index is out of bounds

plus

public final 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.

Specified by:

plus in interface FunctionsAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractDoubleVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractDoubleVectorRel<RU,R,?,?>>

Parameters:

rel - R; 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

public 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.

Specified by:

minus in interface FunctionsAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractDoubleVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractDoubleVectorRel<RU,R,?,?>>

Parameters:

rel - R; 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

public 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.

Specified by:

minus in interface FunctionsAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractDoubleVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractDoubleVectorRel<RU,R,?,?>>

Parameters:

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

checkUnit

static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>> AU checkUnit(S[] dsArray)
                                                                                                                     throws ValueException

Check that a provided array can be used to create some descendant of a DoubleVector, and return the Unit.

Type Parameters:

AU - the absolute unit

RU - the corresponding relative unit

S - the scalar type

Parameters:

dsArray - S[]; the array to check and get the unit for

Returns:

the unit of the object

Throws:

ValueException - when the array has length equal to 0

checkUnit

static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>> AU checkUnit(List<S> dsList)
                                                                                                                     throws ValueException

Check that a provided list can be used to create some descendant of a DoubleVector, and return the Unit.

Type Parameters:

AU - the absolute unit of the scalars in the list

RU - the corresponding relative unit

S - the scalar in the list

Parameters:

dsList - List<S>; the list to check and get the unit for

Returns:

the unit of the object

Throws:

ValueException - when the array has length equal to 0

checkUnit

static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractDoubleScalarAbs<AU,S,RU,?>> AU checkUnit(SortedMap<Integer,S> dsMap)
                                                                                                                     throws ValueException

Check that a provided Map can be used to create some descendant of a DoubleVector.

Type Parameters:

AU - the absolute unit of the scalars in the map

RU - the corresponding relative unit

S - the scalar in the list

Parameters:

dsMap - SortedMap<Integer,S>; the provided map

Returns:

List the provided list

Throws:

ValueException - when the list has size equal to 0

iterator

public Iterator<S> iterator()

Returns an iterator over the scalars in this vector in proper sequence.

Specified by:

iterator in interface Iterable<S extends AbstractDoubleScalarAbs<AU,S,RU,?>>

Returns:

an iterator over the scalars in this vector in proper sequence