org.djunits.value.vdouble.vector

Class ForceVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.AbstractDoubleVector<U,R>

org.djunits.value.vdouble.vector.AbstractDoubleVectorRel<ForceUnit,ForceVector,MutableForceVector,Force>

org.djunits.value.vdouble.vector.ForceVector

All Implemented Interfaces:

Serializable, Iterable<Force>, Relative, Value<ForceUnit>, DoubleVectorInterface<ForceUnit>

public class ForceVector
extends AbstractDoubleVectorRel<ForceUnit,ForceVector,MutableForceVector,Force>

Immutable Double ForceVector, a vector of values with a ForceUnit.

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 9, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.AbstractDoubleVectorRel

AbstractDoubleVectorRel.Itr

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
ForceVector(double[] values, ForceUnit unit, StorageType storageType) Construct a new Relative Immutable Double ForceVector.
ForceVector(DoubleVectorData data, ForceUnit unit)
ForceVector(Force[] values, StorageType storageType) Construct a new Relative Immutable Double ForceVector.
ForceVector(List<Double> values, ForceUnit unit, StorageType storageType) Construct a new Relative Immutable Double ForceVector.
ForceVector(List<Force> values, StorageType storageType) Construct a new Relative Immutable Double ForceVector.
ForceVector(SortedMap<Integer,Double> values, ForceUnit unit, int length, StorageType storageType) Construct a new Relative Immutable Double ForceVector.
ForceVector(SortedMap<Integer,Force> values, int length, StorageType storageType) Construct a new Relative Immutable Double ForceVector.

Method Summary

Modifier and Type	Method and Description
protected MutableForceVector	instantiateMutableType(DoubleVectorData dvd, ForceUnit unit) Construct a new Relative Mutable DoubleVector of the right type.
protected Force	instantiateScalar(double value, ForceUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
protected ForceVector	instantiateType(DoubleVectorData dvd, ForceUnit unit) Construct a new Relative Immutable DoubleVector of the right type.
Force[]	toArray() Return an array of Force Scalars from this vector.
ForceVector	toDense() return a dense version of this vector.
ForceVector	toSparse() return a sparse version of this vector.

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

checkUnit, checkUnit, checkUnit, divide, get, iterator, minus, mutable, plus, times

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

Constructor Detail

ForceVector

public ForceVector(double[] values,
                   ForceUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double ForceVector.

Parameters:

values - double[]; the values of the entries in the new Relative Immutable Double ForceVector

unit - U; the unit of the new Relative Immutable Double ForceVector

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

Throws:

ValueException - when values is null

ForceVector

public ForceVector(List<Double> values,
                   ForceUnit unit,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double ForceVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double ForceVector

unit - U; the unit of the new Relative Immutable Double ForceVector

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

Throws:

ValueException - when values is null

ForceVector

public ForceVector(Force[] values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double ForceVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Double ForceVector

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

Throws:

ValueException - when values has zero entries

ForceVector

public ForceVector(List<Force> values,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double ForceVector.

Parameters:

values - List; the values of the entries in the new Relative Immutable Double ForceVector

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

Throws:

ValueException - when values has zero entries

ForceVector

public ForceVector(SortedMap<Integer,Force> values,
                   int length,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double ForceVector.

Parameters:

values - DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double ForceVector

length - the size of the vector

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

Throws:

ValueException - when values has zero entries

ForceVector

public ForceVector(SortedMap<Integer,Double> values,
                   ForceUnit unit,
                   int length,
                   StorageType storageType)
            throws ValueException

Construct a new Relative Immutable Double ForceVector.

Parameters:

values - Map; the map of indexes to values of the Relative Sparse Mutable Double ForceVector

unit - U; the unit of the new Relative Sparse Mutable Double ForceVector

length - the size of the vector

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

Throws:

ValueException - when values is null

ForceVector

ForceVector(DoubleVectorData data,
            ForceUnit unit)

Parameters:

data - an internal data object

unit - the unit

Method Detail

instantiateType

protected final ForceVector instantiateType(DoubleVectorData dvd,
                                            ForceUnit unit)

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

Specified by:

instantiateType in class AbstractDoubleVectorRel<ForceUnit,ForceVector,MutableForceVector,Force>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

R the DoubleVector of the right type

instantiateMutableType

protected final MutableForceVector instantiateMutableType(DoubleVectorData dvd,
                                                          ForceUnit unit)

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

Specified by:

instantiateMutableType in class AbstractDoubleVectorRel<ForceUnit,ForceVector,MutableForceVector,Force>

Parameters:

dvd - an internal data object

unit - the unit

Returns:

MR the Mutable DoubleVector of the right type

instantiateScalar

protected final Force instantiateScalar(double value,
                                        ForceUnit unit)

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

Specified by:

instantiateScalar in class AbstractDoubleVectorRel<ForceUnit,ForceVector,MutableForceVector,Force>

Parameters:

value - the value

unit - the unit

Returns:

S the Immutable DoubleScalar of the right type

toDense

public final ForceVector toDense()

return a dense version of this vector.

Returns:

a dense version of this vector

toSparse

public final ForceVector toSparse()

return a sparse version of this vector.

Returns:

a sparse version of this vector

toArray

public Force[] toArray()

Return an array of Force Scalars from this vector.

Returns:

Force[]; an array of Force Scalars from this vector

Throws:

RuntimeException - wrapping a ValueException on error getting one of the values