org.djunits.value.vfloat.vector

Class AbstractFloatVectorAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatVectorRel<RU,R,?,?>,MA extends AbstractMutableFloatVectorAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<AU,A>

org.djunits.value.vfloat.vector.AbstractFloatVectorAbs<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>, FloatVectorInterface<AU>

Direct Known Subclasses:

AbstractMutableFloatVectorAbs, FloatAbsoluteTemperatureVector, FloatDirectionVector, FloatPositionVector, FloatTimeVector, FloatVector.Abs

abstract class AbstractFloatVectorAbs<AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,A extends AbstractFloatVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatVectorRel<RU,R,?,?>,MA extends AbstractMutableFloatVectorAbs<AU,RU,A,R,MA,S>,S extends AbstractFloatScalarAbs<AU,S,RU,?>>
extends AbstractFloatVector<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	AbstractFloatVectorAbs.Itr The iterator class is loosely based in AbstractList.Itr.

Field Summary

Fields inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

data

Constructor Summary

Constructors

Constructor and Description
AbstractFloatVectorAbs(float[] values, AU unit, StorageType storageType) Construct a new Absolute Immutable FloatVector.
AbstractFloatVectorAbs(FloatVectorData data, AU unit) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorAbs(List<Float> values, AU unit, StorageType storageType) Construct a new Absolute Immutable FloatVector.
AbstractFloatVectorAbs(List<S> values, StorageType storageType) Construct a new Absolute Immutable FloatVector.
AbstractFloatVectorAbs(S[] values, StorageType storageType) Construct a new Absolute Immutable FloatVector.
AbstractFloatVectorAbs(SortedMap<Integer,Float> values, AU unit, int length, StorageType storageType) Construct a new Absolute Immutable FloatVector.
AbstractFloatVectorAbs(SortedMap<Integer,S> values, int length, StorageType storageType) Construct a new Absolute Immutable FloatVector.

Method Summary

Modifier and Type	Method and Description
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> AU	checkUnit(List<S> dsList) Check that a provided list can be used to create some descendant of a FloatVector, and return the Unit.
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> AU	checkUnit(S[] dsArray) Check that a provided array can be used to create some descendant of a FloatVector, and return the Unit.
(package private) static <AU extends AbsoluteLinearUnit<AU,RU>,RU extends Unit<RU>,S extends AbstractFloatScalarAbs<AU,S,RU,?>> AU	checkUnit(SortedMap<Integer,S> dsMap) Check that a provided Map can be used to create some descendant of a FloatVector.
S	get(int index) Retrieve a value from the vector.
protected abstract MA	instantiateMutableType(FloatVectorData dvd, AU unit) Construct a new Absolute Mutable FloatVector of the right type.
protected abstract S	instantiateScalar(float value, AU unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected abstract A	instantiateTypeAbs(FloatVectorData dvd, AU unit) Construct a new Absolute Immutable FloatVector of the right type.
protected abstract R	instantiateTypeRel(FloatVectorData dvd, RU unit) Construct a new Relative Immutable FloatVector 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 FloatVector.
A	plus(R rel) Add a Relative value to this Absolute value for a vector or matrix.

Methods inherited from class org.djunits.value.vfloat.vector.AbstractFloatVector

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.vfloat.vector.FloatVectorInterface

toDense, toSparse

Constructor Detail

AbstractFloatVectorAbs

AbstractFloatVectorAbs(float[] values,
                       AU unit,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable FloatVector.

Parameters:

values - float[]; the values of the entries in the new Absolute Immutable FloatVector

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

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

Throws:

ValueException - when values is null

AbstractFloatVectorAbs

AbstractFloatVectorAbs(List<Float> values,
                       AU unit,
                       StorageType storageType)
                throws ValueException

Construct a new Absolute Immutable FloatVector.

Parameters:

values - List<Float>; the values of the entries in the new Absolute Immutable FloatVector

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

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

Throws:

ValueException - when values is null

AbstractFloatVectorAbs

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

Construct a new Absolute Immutable FloatVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

AbstractFloatVectorAbs

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

Construct a new Absolute Immutable FloatVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

AbstractFloatVectorAbs

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

Construct a new Absolute Immutable FloatVector.

Parameters:

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

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

AbstractFloatVectorAbs

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

Construct a new Absolute Immutable FloatVector.

Parameters:

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

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

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

AbstractFloatVectorAbs

AbstractFloatVectorAbs(FloatVectorData data,
                       AU unit)

Construct a new Relative Immutable FloatVector.

Parameters:

data - FloatVectorData; an internal data object

unit - AU; the unit

Method Detail

mutable

public MA mutable()

Create a mutable version of this FloatVector.
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 FloatVectorInterface<AU extends AbsoluteLinearUnit<AU,RU>>

Returns:

MA; mutable version of this FloatVector

instantiateTypeAbs

protected abstract A instantiateTypeAbs(FloatVectorData dvd,
                                        AU unit)

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

Parameters:

dvd - FloatVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable FloatVector of the right type

instantiateTypeRel

protected abstract R instantiateTypeRel(FloatVectorData dvd,
                                        RU unit)

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

Parameters:

dvd - FloatVectorData; an internal data object

unit - RU; the unit

Returns:

M the Mutable FloatVector of the right type

instantiateMutableType

protected abstract MA instantiateMutableType(FloatVectorData dvd,
                                             AU unit)

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

Parameters:

dvd - FloatVectorData; an internal data object

unit - AU; the unit

Returns:

M the Mutable FloatVector of the right type

instantiateScalar

protected abstract S instantiateScalar(float value,
                                       AU unit)

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

Parameters:

value - float; the value

unit - AU; the unit

Returns:

S the Immutable FloatScalar of the right type

get

public S get(int index)
      throws ValueException

Retrieve a value from the vector.

Specified by:

get in class AbstractFloatVector<AU extends AbsoluteLinearUnit<AU,RU>,A extends AbstractFloatVectorAbs<AU,RU,A,R,MA,S>>

Parameters:

index - int; the index to retrieve the value at

Returns:

the value as a FloatScalar

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 AbstractFloatVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatVectorRel<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 AbstractFloatVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatVectorRel<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 AbstractFloatVectorAbs<AU,RU,A,R,MA,S>,R extends AbstractFloatVectorRel<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 AbstractFloatScalarAbs<AU,S,RU,?>> AU checkUnit(S[] dsArray)
                                                                                                                    throws ValueException

Check that a provided array can be used to create some descendant of a FloatVector, 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 AbstractFloatScalarAbs<AU,S,RU,?>> AU checkUnit(List<S> dsList)
                                                                                                                    throws ValueException

Check that a provided list can be used to create some descendant of a FloatVector, 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 AbstractFloatScalarAbs<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 FloatVector.

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 AbstractFloatScalarAbs<AU,S,RU,?>>

Returns:

an iterator over the scalars in this vector in proper sequence