1 package org.djunits.value.vfloat.vector;
2
3 import java.util.List;
4 import java.util.SortedMap;
5
6 import org.djunits.unit.DensityUnit;
7 import org.djunits.value.StorageType;
8 import org.djunits.value.ValueException;
9 import org.djunits.value.vfloat.scalar.FloatDensity;
10
11 /**
12 * Mutable Float DensityVector, a vector of values with a DensityUnit.
13 * <p>
14 * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
15 * BSD-style license. See <a href="http://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
16 * </p>
17 * $LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $,
18 * initial version Oct 9, 2015 <br>
19 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
20 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
21 */
22 public class MutableFloatDensityVector
23 extends AbstractMutableFloatVectorRel<DensityUnit, FloatDensityVector, MutableFloatDensityVector, FloatDensity>
24 {
25 /** */
26 private static final long serialVersionUID = 20151109L;
27
28 /**
29 * Construct a new Relative Immutable Float DensityVector.
30 * @param values float[]; the values of the entries in the new Relative Immutable Float DensityVector
31 * @param unit DensityUnit; the unit of the new Relative Immutable Float DensityVector
32 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
33 * @throws ValueException when values is null
34 */
35 public MutableFloatDensityVector(final float[] values, final DensityUnit unit, final StorageType storageType)
36 throws ValueException
37 {
38 super(values, unit, storageType);
39 }
40
41 /**
42 * Construct a new Relative Immutable Float DensityVector.
43 * @param values List<Float>; the values of the entries in the new Relative Immutable Float DensityVector
44 * @param unit DensityUnit; the unit of the new Relative Immutable Float DensityVector
45 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
46 * @throws ValueException when values is null
47 */
48 public MutableFloatDensityVector(final List<Float> values, final DensityUnit unit, final StorageType storageType)
49 throws ValueException
50 {
51 super(values, unit, storageType);
52 }
53
54 /**
55 * Construct a new Relative Immutable Float DensityVector.
56 * @param values FloatDensity[]; the values of the entries in the new Relative Immutable Float DensityVector
57 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
58 * @throws ValueException when values has zero entries
59 */
60 public MutableFloatDensityVector(final FloatDensity[] values, final StorageType storageType) throws ValueException
61 {
62 super(values, storageType);
63 }
64
65 /**
66 * Construct a new Relative Immutable Float DensityVector.
67 * @param values List<FloatDensity>; the values of the entries in the new Relative Immutable Float DensityVector
68 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
69 * @throws ValueException when values has zero entries
70 */
71 public MutableFloatDensityVector(final List<FloatDensity> values, final StorageType storageType) throws ValueException
72 {
73 super(values, storageType);
74 }
75
76 /**
77 * Construct a new Relative Immutable Float DensityVector.
78 * @param values SortedMap<Integer, FloatDensity>; the values of the entries in the new Relative Sparse Mutable Float
79 * DensityVector
80 * @param length int; the size of the vector
81 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
82 * @throws ValueException when values has zero entries
83 */
84 public MutableFloatDensityVector(final SortedMap<Integer, FloatDensity> values, final int length,
85 final StorageType storageType) throws ValueException
86 {
87 super(values, length, storageType);
88 }
89
90 /**
91 * Construct a new Relative Immutable Float DensityVector.
92 * @param values SortedMap<Integer, Float>; the map of indexes to values of the Relative Sparse Mutable Float
93 * DensityVector
94 * @param unit DensityUnit; the unit of the new Relative Sparse Mutable Float DensityVector
95 * @param length int; the size of the vector
96 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
97 * @throws ValueException when values is null
98 */
99 public MutableFloatDensityVector(final SortedMap<Integer, Float> values, final DensityUnit unit, final int length,
100 final StorageType storageType) throws ValueException
101 {
102 super(values, unit, length, storageType);
103 }
104
105 /**
106 * @param data FloatVectorData; an internal data object
107 * @param unit DensityUnit; the unit
108 */
109 MutableFloatDensityVector(final FloatVectorData data, final DensityUnit unit)
110 {
111 super(data, unit);
112 }
113
114 /** {@inheritDoc} */
115 @Override
116 protected final FloatDensityVector instantiateType(final FloatVectorData dvd, final DensityUnit unit)
117 {
118 return new FloatDensityVector(dvd, unit);
119 }
120
121 /** {@inheritDoc} */
122 @Override
123 protected final MutableFloatDensityVector instantiateMutableType(final FloatVectorData dvd, final DensityUnit unit)
124 {
125 return new MutableFloatDensityVector(dvd, unit);
126 }
127
128 /** {@inheritDoc} */
129 @Override
130 protected final FloatDensity instantiateScalar(final float value, final DensityUnit unit)
131 {
132 return new FloatDensity(value, unit);
133 }
134
135 /** {@inheritDoc} */
136 @Override
137 public final MutableFloatDensityVector toDense()
138 {
139 return this.data.isDense() ? (MutableFloatDensityVector) this : instantiateMutableType(this.data.toDense(), getUnit());
140 }
141
142 /** {@inheritDoc} */
143 @Override
144 public final MutableFloatDensityVector toSparse()
145 {
146 return this.data.isSparse() ? (MutableFloatDensityVector) this
147 : instantiateMutableType(this.data.toSparse(), getUnit());
148 }
149
150 /**
151 * Return an array of FloatDensity Scalars from this vector.
152 * @return FloatDensity[]; an array of FloatDensity Scalars from this vector
153 * @throws RuntimeException wrapping a ValueException on error getting one of the values
154 */
155 public FloatDensity[] toArray()
156 {
157 FloatDensity[] array = new FloatDensity[size()];
158 for (int i = 0; i < size(); i++)
159 {
160 try
161 {
162 array[i] = get(i);
163 }
164 catch (ValueException exception)
165 {
166 throw new RuntimeException(exception);
167 }
168 }
169 return array;
170 }
171
172 }