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 * Immutable Double ElectricalPotentialVector, a vector of values with a ElectricalPotentialUnit.
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 ElectricalPotentialVector extends AbstractDoubleVectorRel<ElectricalPotentialUnit, ElectricalPotentialVector,
23 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 ElectricalPotentialUnit; the unit of the new Relative Immutable Double ElectricalPotentialVector
32 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
33 * @throws ValueException when values is null
34 */
35 public ElectricalPotentialVector(final double[] values, final ElectricalPotentialUnit unit, final StorageType storageType)
36 throws ValueException
37 {
38 super(values, unit, storageType);
39 }
40
41 /**
42 * Construct a new Relative Immutable Double ElectricalPotentialVector.
43 * @param values List<Double>; the values of the entries in the new Relative Immutable Double
44 * ElectricalPotentialVector
45 * @param unit ElectricalPotentialUnit; the unit of the new Relative Immutable Double ElectricalPotentialVector
46 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
47 * @throws ValueException when values is null
48 */
49 public ElectricalPotentialVector(final List<Double> values, final ElectricalPotentialUnit unit,
50 final StorageType storageType) throws ValueException
51 {
52 super(values, unit, storageType);
53 }
54
55 /**
56 * Construct a new Relative Immutable Double ElectricalPotentialVector.
57 * @param values ElectricalPotential[]; the values of the entries in the new Relative Immutable Double
58 * ElectricalPotentialVector
59 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
60 * @throws ValueException when values has zero entries
61 */
62 public ElectricalPotentialVector(final ElectricalPotential[] values, final StorageType storageType) throws ValueException
63 {
64 super(values, storageType);
65 }
66
67 /**
68 * Construct a new Relative Immutable Double ElectricalPotentialVector.
69 * @param values List<ElectricalPotential>; the values of the entries in the new Relative Immutable Double
70 * ElectricalPotentialVector
71 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
72 * @throws ValueException when values has zero entries
73 */
74 public ElectricalPotentialVector(final List<ElectricalPotential> values, final StorageType storageType)
75 throws ValueException
76 {
77 super(values, storageType);
78 }
79
80 /**
81 * Construct a new Relative Immutable Double ElectricalPotentialVector.
82 * @param values SortedMap<Integer, ElectricalPotential>; the values of the entries in the new Relative Sparse Mutable
83 * Double ElectricalPotentialVector
84 * @param length int; the size of the vector
85 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
86 * @throws ValueException when values has zero entries
87 */
88 public ElectricalPotentialVector(final SortedMap<Integer, ElectricalPotential> values, final int length,
89 final StorageType storageType) throws ValueException
90 {
91 super(values, length, storageType);
92 }
93
94 /**
95 * Construct a new Relative Immutable Double ElectricalPotentialVector.
96 * @param values SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Mutable Double
97 * ElectricalPotentialVector
98 * @param unit ElectricalPotentialUnit; the unit of the new Relative Sparse Mutable Double ElectricalPotentialVector
99 * @param length int; the size of the vector
100 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
101 * @throws ValueException when values is null
102 */
103 public ElectricalPotentialVector(final SortedMap<Integer, Double> values, final ElectricalPotentialUnit unit,
104 final int length, final StorageType storageType) throws ValueException
105 {
106 super(values, unit, length, storageType);
107 }
108
109 /**
110 * @param data DoubleVectorData; an internal data object
111 * @param unit ElectricalPotentialUnit; the unit
112 */
113 ElectricalPotentialVector(final DoubleVectorData data, final ElectricalPotentialUnit unit)
114 {
115 super(data, unit);
116 }
117
118 /** {@inheritDoc} */
119 @Override
120 protected final ElectricalPotentialVector instantiateType(final DoubleVectorData dvd, final ElectricalPotentialUnit unit)
121 {
122 return new ElectricalPotentialVector(dvd, unit);
123 }
124
125 /** {@inheritDoc} */
126 @Override
127 protected final MutableElectricalPotentialVector instantiateMutableType(final DoubleVectorData dvd,
128 final ElectricalPotentialUnit unit)
129 {
130 return new MutableElectricalPotentialVector(dvd, unit);
131 }
132
133 /** {@inheritDoc} */
134 @Override
135 protected final ElectricalPotential instantiateScalar(final double value, final ElectricalPotentialUnit unit)
136 {
137 return new ElectricalPotential(value, unit);
138 }
139
140 /** {@inheritDoc} */
141 @Override
142 public final ElectricalPotentialVector toDense()
143 {
144 return this.data.isDense() ? (ElectricalPotentialVector) this : instantiateType(this.data.toDense(), getUnit());
145 }
146
147 /** {@inheritDoc} */
148 @Override
149 public final ElectricalPotentialVector toSparse()
150 {
151 return this.data.isSparse() ? (ElectricalPotentialVector) this : instantiateType(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 }