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