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