1 package org.djunits.value.vfloat.vector;
2
3 import java.util.List;
4 import java.util.SortedMap;
5
6 import org.djunits.unit.VolumeUnit;
7 import org.djunits.value.StorageType;
8 import org.djunits.value.ValueException;
9 import org.djunits.value.vfloat.scalar.FloatVolume;
10
11 /**
12 * Immutable Float FloatVolumeVector, a vector of values with a VolumeUnit.
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 FloatVolumeVector
23 extends AbstractFloatVectorRel<VolumeUnit, FloatVolumeVector, MutableFloatVolumeVector, FloatVolume>
24 {
25 /** */
26 private static final long serialVersionUID = 20151109L;
27
28 /**
29 * Construct a new Relative Immutable Float FloatVolumeVector.
30 * @param values float[]; the values of the entries in the new Relative Immutable Float FloatVolumeVector
31 * @param unit VolumeUnit; the unit of the new Relative Immutable Float FloatVolumeVector
32 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
33 * @throws ValueException when values is null
34 */
35 public FloatVolumeVector(final float[] values, final VolumeUnit unit, final StorageType storageType) throws ValueException
36 {
37 super(values, unit, storageType);
38 }
39
40 /**
41 * Construct a new Relative Immutable Float FloatVolumeVector.
42 * @param values List<Float>; the values of the entries in the new Relative Immutable Float FloatVolumeVector
43 * @param unit VolumeUnit; the unit of the new Relative Immutable Float FloatVolumeVector
44 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
45 * @throws ValueException when values is null
46 */
47 public FloatVolumeVector(final List<Float> values, final VolumeUnit unit, final StorageType storageType)
48 throws ValueException
49 {
50 super(values, unit, storageType);
51 }
52
53 /**
54 * Construct a new Relative Immutable Float FloatVolumeVector.
55 * @param values FloatVolume[]; the values of the entries in the new Relative Immutable Float FloatVolumeVector
56 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
57 * @throws ValueException when values has zero entries
58 */
59 public FloatVolumeVector(final FloatVolume[] values, final StorageType storageType) throws ValueException
60 {
61 super(values, storageType);
62 }
63
64 /**
65 * Construct a new Relative Immutable Float FloatVolumeVector.
66 * @param values List<FloatVolume>; the values of the entries in the new Relative Immutable Float FloatVolumeVector
67 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
68 * @throws ValueException when values has zero entries
69 */
70 public FloatVolumeVector(final List<FloatVolume> values, final StorageType storageType) throws ValueException
71 {
72 super(values, storageType);
73 }
74
75 /**
76 * Construct a new Relative Immutable Float FloatVolumeVector.
77 * @param values SortedMap<Integer, FloatVolume>; the values of the entries in the new Relative Sparse Mutable Float
78 * FloatVolumeVector
79 * @param length int; the size of the vector
80 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
81 * @throws ValueException when values has zero entries
82 */
83 public FloatVolumeVector(final SortedMap<Integer, FloatVolume> values, final int length, final StorageType storageType)
84 throws ValueException
85 {
86 super(values, length, storageType);
87 }
88
89 /**
90 * Construct a new Relative Immutable Float FloatVolumeVector.
91 * @param values SortedMap<Integer, Float>; the map of indexes to values of the Relative Sparse Mutable Float
92 * FloatVolumeVector
93 * @param unit VolumeUnit; the unit of the new Relative Sparse Mutable Float FloatVolumeVector
94 * @param length int; the size of the vector
95 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
96 * @throws ValueException when values is null
97 */
98 public FloatVolumeVector(final SortedMap<Integer, Float> values, final VolumeUnit unit, final int length,
99 final StorageType storageType) throws ValueException
100 {
101 super(values, unit, length, storageType);
102 }
103
104 /**
105 * @param data FloatVectorData; an internal data object
106 * @param unit VolumeUnit; the unit
107 */
108 FloatVolumeVector(final FloatVectorData data, final VolumeUnit unit)
109 {
110 super(data, unit);
111 }
112
113 /** {@inheritDoc} */
114 @Override
115 protected final FloatVolumeVector instantiateType(final FloatVectorData dvd, final VolumeUnit unit)
116 {
117 return new FloatVolumeVector(dvd, unit);
118 }
119
120 /** {@inheritDoc} */
121 @Override
122 protected final MutableFloatVolumeVector instantiateMutableType(final FloatVectorData dvd, final VolumeUnit unit)
123 {
124 return new MutableFloatVolumeVector(dvd, unit);
125 }
126
127 /** {@inheritDoc} */
128 @Override
129 protected final FloatVolume instantiateScalar(final float value, final VolumeUnit unit)
130 {
131 return new FloatVolume(value, unit);
132 }
133
134 /** {@inheritDoc} */
135 @Override
136 public final FloatVolumeVector toDense()
137 {
138 return this.data.isDense() ? (FloatVolumeVector) this : instantiateType(this.data.toDense(), getUnit());
139 }
140
141 /** {@inheritDoc} */
142 @Override
143 public final FloatVolumeVector toSparse()
144 {
145 return this.data.isSparse() ? (FloatVolumeVector) this : instantiateType(this.data.toSparse(), getUnit());
146 }
147
148 /**
149 * Return an array of FloatVolume Scalars from this vector.
150 * @return FloatVolume[]; an array of FloatVolume Scalars from this vector
151 * @throws RuntimeException wrapping a ValueException on error getting one of the values
152 */
153 public FloatVolume[] toArray()
154 {
155 FloatVolume[] array = new FloatVolume[size()];
156 for (int i = 0; i < size(); i++)
157 {
158 try
159 {
160 array[i] = get(i);
161 }
162 catch (ValueException exception)
163 {
164 throw new RuntimeException(exception);
165 }
166 }
167 return array;
168 }
169
170 }