org.djunits.value.vfloat.vector

Class AbstractFloatVectorRel<U extends Unit<U>,R extends AbstractFloatVectorRel<U,R,MR,S>,MR extends AbstractMutableFloatVectorRel<U,R,MR,S>,S extends AbstractFloatScalarRel<U,S>>

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vfloat.vector.AbstractFloatVector<U,R>

org.djunits.value.vfloat.vector.AbstractFloatVectorRel<U,R,MR,S>

Type Parameters:

U - the unit

R - the relative vector type

MR - the mutable relative vector type

S - the relative scalar type

All Implemented Interfaces:

Serializable, Iterable<S>, Relative, Value<U>, FloatVectorInterface<U>

Direct Known Subclasses:

AbstractMutableFloatVectorRel, FloatAccelerationVector, FloatAngleSolidVector, FloatAngleVector, FloatAreaVector, FloatDensityVector, FloatDimensionlessVector, FloatDurationVector, FloatElectricalChargeVector, FloatElectricalCurrentVector, FloatElectricalPotentialVector, FloatElectricalResistanceVector, FloatEnergyVector, FloatFlowMassVector, FloatFlowVolumeVector, FloatForceVector, FloatFrequencyVector, FloatLengthVector, FloatLinearDensityVector, FloatMassVector, FloatMoneyPerAreaVector, FloatMoneyPerDurationVector, FloatMoneyPerEnergyVector, FloatMoneyPerLengthVector, FloatMoneyPerMassVector, FloatMoneyPerVolumeVector, FloatMoneyVector, FloatPowerVector, FloatPressureVector, FloatSpeedVector, FloatTemperatureVector, FloatTorqueVector, FloatVector.Rel, FloatVolumeVector

abstract class AbstractFloatVectorRel<U extends Unit<U>,R extends AbstractFloatVectorRel<U,R,MR,S>,MR extends AbstractMutableFloatVectorRel<U,R,MR,S>,S extends AbstractFloatScalarRel<U,S>>
extends AbstractFloatVector<U,R>
implements Relative, Serializable, Iterable<S>

Relative 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	AbstractFloatVectorRel.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
AbstractFloatVectorRel(float[] values, U unit, StorageType storageType) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorRel(FloatVectorData data, U unit) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorRel(List<Float> values, U unit, StorageType storageType) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorRel(List<S> values, StorageType storageType) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorRel(S[] values, StorageType storageType) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorRel(SortedMap<Integer,Float> values, U unit, int length, StorageType storageType) Construct a new Relative Immutable FloatVector.
AbstractFloatVectorRel(SortedMap<Integer,S> values, int length, StorageType storageType) Construct a new Relative Immutable FloatVector.

Method Summary

Modifier and Type	Method and Description
(package private) static <U extends Unit<U>,S extends AbstractFloatScalarRel<U,S>> U	checkUnit(AbstractFloatScalarRel<U,S>[] dsArray) Check that a provided array can be used to create some descendant of a FloatVector, and return the Unit.
(package private) static <U extends Unit<U>,S extends AbstractFloatScalarRel<U,S>> U	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 <U extends Unit<U>,S extends AbstractFloatScalarRel<U,S>> U	checkUnit(SortedMap<Integer,S> dsMap) Check that a provided Map can be used to create some descendant of a FloatVector.
R	divide(R rel) Divide this Relative value by a Relative value for a vector or matrix.
S	get(int index) Retrieve a value from the vector.
protected abstract MR	instantiateMutableType(FloatVectorData dvd, U unit) Construct a new Relative Mutable FloatVector of the right type.
protected abstract S	instantiateScalar(float value, U unit) Construct a new Relative Immutable FloatScalar of the right type.
protected abstract R	instantiateType(FloatVectorData dvd, U 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(R rel) Subtract a Relative value from this Relative value for a vector or matrix.
MR	mutable() Create a mutable version of this FloatVector.
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 with this Relative 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

AbstractFloatVectorRel

AbstractFloatVectorRel(float[] values,
                       U unit,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable FloatVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable FloatVector

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

Throws:

ValueException - when values is null

AbstractFloatVectorRel

AbstractFloatVectorRel(List<Float> values,
                       U unit,
                       StorageType storageType)
                throws ValueException

Construct a new Relative Immutable FloatVector.

Parameters:

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

unit - U; the unit of the new Relative Immutable FloatVector

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

Throws:

ValueException - when values is null

AbstractFloatVectorRel

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

Construct a new Relative Immutable FloatVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

AbstractFloatVectorRel

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

Construct a new Relative Immutable FloatVector.

Parameters:

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

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

Throws:

ValueException - when values has zero entries

AbstractFloatVectorRel

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

Construct a new Relative Immutable FloatVector.

Parameters:

values - SortedMap<Integer, S>; the values of the entries in the new Relative 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

AbstractFloatVectorRel

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

Construct a new Relative Immutable FloatVector.

Parameters:

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

unit - U; the unit of the new Relative 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

AbstractFloatVectorRel

AbstractFloatVectorRel(FloatVectorData data,
                       U unit)

Construct a new Relative Immutable FloatVector.

Parameters:

data - FloatVectorData; an internal data object

unit - U; the unit

Method Detail

mutable

public MR 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<U extends Unit<U>>

Returns:

MR; mutable version of this FloatVector

instantiateType

protected abstract R instantiateType(FloatVectorData dvd,
                                     U 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 - U; the unit

Returns:

R the FloatVector of the right type

instantiateMutableType

protected abstract MR instantiateMutableType(FloatVectorData dvd,
                                             U unit)

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

Parameters:

dvd - FloatVectorData; an internal data object

unit - U; the unit

Returns:

MR the Mutable FloatVector of the right type

instantiateScalar

protected abstract S instantiateScalar(float value,
                                       U unit)

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

Parameters:

value - float; the value

unit - U; 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<U extends Unit<U>,R extends AbstractFloatVectorRel<U,R,MR,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 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 store the result 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:

the addition of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

minus

public final 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 store the result 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:

the subtraction of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

times

public final R times(R rel)
              throws ValueException

Multiply a Relative value with this Relative value for a vector or matrix. The multiplication is done value by value and store the result 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:

the multiplication of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

divide

public final 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 store the result 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:

the division of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

checkUnit

static <U extends Unit<U>,S extends AbstractFloatScalarRel<U,S>> U checkUnit(AbstractFloatScalarRel<U,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:

U - the unit

S - the scalar type

Parameters:

dsArray - AbstractFloatScalarRel<U,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 <U extends Unit<U>,S extends AbstractFloatScalarRel<U,S>> U 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:

U - the 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 <U extends Unit<U>,S extends AbstractFloatScalarRel<U,S>> U checkUnit(SortedMap<Integer,S> dsMap)
                                                                      throws ValueException

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

Type Parameters:

U - Unit; the unit of the FloatScalar list

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 AbstractFloatScalarRel<U,S>>

Returns:

an iterator over the scalars in this vector in proper sequence