Package org.djunits.value

Interface IndexedValue<U extends Unit<U>,S extends Scalar<U,S>,T extends IndexedValue<U,S,T>>

Type Parameters:

U - the unit type

S - the scalar type for the U unit

T - the value type for this unit

All Superinterfaces:

Cloneable, Serializable, Value<U,T>, ValueFunctions<U,T>

All Known Subinterfaces:

DoubleMatrixInterface<U,S,V,M>, DoubleVectorInterface<U,S,V>, FloatMatrixInterface<U,S,V,M>, FloatVectorInterface<U,S,V>, Matrix<U,S,V,M>, Matrix.Abs<AU,A,AV,AM,RU,R,RV,RM>, Matrix.Rel<U,S,V,RM>, Matrix.RelWithAbs<AU,A,AV,AM,RU,R,RV,RM>, Vector<U,S,V>, Vector.Abs<AU,A,AV,RU,R,RV>, Vector.Rel<U,S,RV>, Vector.RelWithAbs<AU,A,AV,RU,R,RV>

All Known Implementing Classes:

AbsoluteTemperatureMatrix, AbsoluteTemperatureVector, AbsorbedDoseMatrix, AbsorbedDoseVector, AbstractDoubleMatrix, AbstractDoubleMatrixAbs, AbstractDoubleMatrixRel, AbstractDoubleMatrixRelWithAbs, AbstractDoubleVector, AbstractDoubleVectorAbs, AbstractDoubleVectorRel, AbstractDoubleVectorRelWithAbs, AbstractFloatMatrix, AbstractFloatMatrixAbs, AbstractFloatMatrixRel, AbstractFloatMatrixRelWithAbs, AbstractFloatVector, AbstractFloatVectorAbs, AbstractFloatVectorRel, AbstractFloatVectorRelWithAbs, AbstractIndexedValue, AccelerationMatrix, AccelerationVector, AmountOfSubstanceMatrix, AmountOfSubstanceVector, AngleMatrix, AngleVector, AreaMatrix, AreaVector, CatalyticActivityMatrix, CatalyticActivityVector, DensityMatrix, DensityVector, DimensionlessMatrix, DimensionlessVector, DirectionMatrix, DirectionVector, DurationMatrix, DurationVector, ElectricalCapacitanceMatrix, ElectricalCapacitanceVector, ElectricalChargeMatrix, ElectricalChargeVector, ElectricalConductanceMatrix, ElectricalConductanceVector, ElectricalCurrentMatrix, ElectricalCurrentVector, ElectricalInductanceMatrix, ElectricalInductanceVector, ElectricalPotentialMatrix, ElectricalPotentialVector, ElectricalResistanceMatrix, ElectricalResistanceVector, EnergyMatrix, EnergyVector, EquivalentDoseMatrix, EquivalentDoseVector, FloatAbsoluteTemperatureMatrix, FloatAbsoluteTemperatureVector, FloatAbsorbedDoseMatrix, FloatAbsorbedDoseVector, FloatAccelerationMatrix, FloatAccelerationVector, FloatAmountOfSubstanceMatrix, FloatAmountOfSubstanceVector, FloatAngleMatrix, FloatAngleVector, FloatAreaMatrix, FloatAreaVector, FloatCatalyticActivityMatrix, FloatCatalyticActivityVector, FloatDensityMatrix, FloatDensityVector, FloatDimensionlessMatrix, FloatDimensionlessVector, FloatDirectionMatrix, FloatDirectionVector, FloatDurationMatrix, FloatDurationVector, FloatElectricalCapacitanceMatrix, FloatElectricalCapacitanceVector, FloatElectricalChargeMatrix, FloatElectricalChargeVector, FloatElectricalConductanceMatrix, FloatElectricalConductanceVector, FloatElectricalCurrentMatrix, FloatElectricalCurrentVector, FloatElectricalInductanceMatrix, FloatElectricalInductanceVector, FloatElectricalPotentialMatrix, FloatElectricalPotentialVector, FloatElectricalResistanceMatrix, FloatElectricalResistanceVector, FloatEnergyMatrix, FloatEnergyVector, FloatEquivalentDoseMatrix, FloatEquivalentDoseVector, FloatFlowMassMatrix, FloatFlowMassVector, FloatFlowVolumeMatrix, FloatFlowVolumeVector, FloatForceMatrix, FloatForceVector, FloatFrequencyMatrix, FloatFrequencyVector, FloatIlluminanceMatrix, FloatIlluminanceVector, FloatLengthMatrix, FloatLengthVector, FloatLinearDensityMatrix, FloatLinearDensityVector, FloatLuminousFluxMatrix, FloatLuminousFluxVector, FloatLuminousIntensityMatrix, FloatLuminousIntensityVector, FloatMagneticFluxDensityMatrix, FloatMagneticFluxDensityVector, FloatMagneticFluxMatrix, FloatMagneticFluxVector, FloatMassMatrix, FloatMassVector, FloatPositionMatrix, FloatPositionVector, FloatPowerMatrix, FloatPowerVector, FloatPressureMatrix, FloatPressureVector, FloatRadioActivityMatrix, FloatRadioActivityVector, FloatSIMatrix, FloatSIVector, FloatSolidAngleMatrix, FloatSolidAngleVector, FloatSpeedMatrix, FloatSpeedVector, FloatTemperatureMatrix, FloatTemperatureVector, FloatTimeMatrix, FloatTimeVector, FloatTorqueMatrix, FloatTorqueVector, FloatVolumeMatrix, FloatVolumeVector, FlowMassMatrix, FlowMassVector, FlowVolumeMatrix, FlowVolumeVector, ForceMatrix, ForceVector, FrequencyMatrix, FrequencyVector, IlluminanceMatrix, IlluminanceVector, LengthMatrix, LengthVector, LinearDensityMatrix, LinearDensityVector, LuminousFluxMatrix, LuminousFluxVector, LuminousIntensityMatrix, LuminousIntensityVector, MagneticFluxDensityMatrix, MagneticFluxDensityVector, MagneticFluxMatrix, MagneticFluxVector, MassMatrix, MassVector, PositionMatrix, PositionVector, PowerMatrix, PowerVector, PressureMatrix, PressureVector, RadioActivityMatrix, RadioActivityVector, SIMatrix, SIVector, SolidAngleMatrix, SolidAngleVector, SpeedMatrix, SpeedVector, TemperatureMatrix, TemperatureVector, TimeMatrix, TimeVector, TorqueMatrix, TorqueVector, VolumeMatrix, VolumeVector

public interface IndexedValue<U extends Unit<U>,S extends Scalar<U,S>,T extends IndexedValue<U,S,T>>
extends Value<U,T>

IndexedValue.java.

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

Author:

Alexander Verbraeck

Method Summary

Modifier and Type	Method	Description
int	cardinality()	Count the number of cells that have a non-zero SI value.
Class<S>	getScalarClass()	Return the class of the corresponding scalar.
StorageType	getStorageType()	Return the StorageType (DENSE, SPARSE, etc.) for the stored vector.
T	immutable()	Turn the immutable flag on for this vector.
boolean	isDense()	Return whether the internal storage type of the indexed value is dense or not.
boolean	isMutable()	Return whether the data is mutable or not.
boolean	isSparse()	Return whether the internal storage type of the indexed value is sparse or not.
T	mutable()	Turn the immutable flag off for this internal storage.
T	toDense()	Create and return a dense version of this internal storage.
T	toSparse()	Create and return a sparse version of this internal storage.

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Method Details

getStorageType

StorageType getStorageType()

Return the StorageType (DENSE, SPARSE, etc.) for the stored vector.

Returns:

StorageType; the storage type (DENSE, SPARSE, etc.) for the stored vector

toDense

T toDense()

Create and return a dense version of this internal storage. When the data was already dense, the current version is returned and no copy will be made of the data.

Returns:

T; a dense version of this internal storage

toSparse

T toSparse()

Create and return a sparse version of this internal storage. When the data was already sparse, the current version is returned and no copy will be made of the data.

Returns:

T; a sparse version of this internal storage

isDense

boolean isDense()

Return whether the internal storage type of the indexed value is dense or not.

Returns:

boolean; whether the internal storage type of the indexed value is dense or not

isSparse

boolean isSparse()

Return whether the internal storage type of the indexed value is sparse or not.

Returns:

boolean; whether the internal storage type of the indexed value is sparse or not

isMutable

boolean isMutable()

Return whether the data is mutable or not.

Returns:

boolean; whether the data is mutable or not

immutable

T immutable()

Turn the immutable flag on for this vector.

Returns:

T; the vector with a raised immutable flag

mutable

T mutable()

Turn the immutable flag off for this internal storage.

Returns:

T; the internal storage with a cleared immutable flag

cardinality

int cardinality()

Count the number of cells that have a non-zero SI value.

Returns:

int; the number of cells having non-zero SI value

getScalarClass

Class<S> getScalarClass()

Return the class of the corresponding scalar.

Returns:

Class<S>; the class of the corresponding scalar