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