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