1 package org.djunits.value.vdouble.vector;
2
3 import java.util.List;
4 import java.util.SortedMap;
5
6 import org.djunits.unit.DurationUnit;
7 import org.djunits.unit.TimeUnit;
8 import org.djunits.value.StorageType;
9 import org.djunits.value.ValueException;
10 import org.djunits.value.vdouble.scalar.Time;
11
12 /**
13 * Immutable Absolute Time Vector.
14 * <p>
15 * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
16 * BSD-style license. See <a href="http://djunits.org/docs/license.html">DJUNITS License</a>.
17 * <p>
18 * $LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial
19 * version Sep 5, 2015 <br>
20 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
21 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
22 */
23 public class TimeVector
24 extends AbstractDoubleVectorAbs<TimeUnit, DurationUnit, TimeVector, DurationVector, MutableTimeVector, Time>
25 {
26 /** */
27 private static final long serialVersionUID = 20151003L;
28
29 /**
30 * Construct a new Absolute Immutable Double TimeVector.
31 * @param values double[]; the values of the entries in the new Absolute Immutable Double TimeVector
32 * @param unit TimeUnit; the unit of the new Absolute Immutable Double TimeVector
33 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
34 * @throws ValueException when values is null
35 */
36 public TimeVector(final double[] values, final TimeUnit unit, final StorageType storageType) throws ValueException
37 {
38 super(values, unit, storageType);
39 }
40
41 /**
42 * Construct a new Absolute Immutable Double TimeVector.
43 * @param values List<Double>; the values of the entries in the new Absolute Immutable Double TimeVector
44 * @param unit TimeUnit; the unit of the new Absolute Immutable Double TimeVector
45 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
46 * @throws ValueException when values is null
47 */
48 public TimeVector(final List<Double> values, final TimeUnit unit, final StorageType storageType) throws ValueException
49 {
50 super(values, unit, storageType);
51 }
52
53 /**
54 * Construct a new Absolute Immutable Double TimeVector.
55 * @param values Time[]; the values of the entries in the new Absolute Immutable Double TimeVector
56 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
57 * @throws ValueException when values has zero entries
58 */
59 public TimeVector(final Time[] values, final StorageType storageType) throws ValueException
60 {
61 super(values, storageType);
62 }
63
64 /**
65 * Construct a new Absolute Immutable Double TimeVector.
66 * @param values List<Time>; the values of the entries in the new Absolute Immutable Double TimeVector
67 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
68 * @throws ValueException when values has zero entries
69 */
70 public TimeVector(final List<Time> values, final StorageType storageType) throws ValueException
71 {
72 super(values, storageType);
73 }
74
75 /**
76 * Construct a new Absolute Immutable Double TimeVector.
77 * @param values SortedMap<Integer, Time>; the values of the entries in the new Absolute Sparse Mutable Double
78 * TimeVector
79 * @param length int; the size of the vector
80 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
81 * @throws ValueException when values has zero entries
82 */
83 public TimeVector(final SortedMap<Integer, Time> values, final int length, final StorageType storageType)
84 throws ValueException
85 {
86 super(values, length, storageType);
87 }
88
89 /**
90 * Construct a new Absolute Immutable Double TimeVector.
91 * @param values SortedMap<Integer, Double>; the map of indexes to values of the Absolute Sparse Mutable Double
92 * TimeVector
93 * @param unit TimeUnit; the unit of the new Absolute Sparse Mutable Double TimeVector
94 * @param length int; the size of the vector
95 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
96 * @throws ValueException when values is null
97 */
98 public TimeVector(final SortedMap<Integer, Double> values, final TimeUnit unit, final int length,
99 final StorageType storageType) throws ValueException
100 {
101 super(values, unit, length, storageType);
102 }
103
104 /**
105 * Construct a new Absolute Immutable Double TimeVector.
106 * @param data DoubleVectorData; an internal data object
107 * @param unit TimeUnit; the unit
108 */
109 TimeVector(final DoubleVectorData data, final TimeUnit unit)
110 {
111 super(data, unit);
112 }
113
114 /** {@inheritDoc} */
115 @Override
116 protected final TimeVector instantiateTypeAbs(final DoubleVectorData dvd, final TimeUnit unit)
117 {
118 return new TimeVector(dvd, unit);
119 }
120
121 /** {@inheritDoc} */
122 @Override
123 protected final DurationVector instantiateTypeRel(final DoubleVectorData dvd, final DurationUnit unit)
124 {
125 return new DurationVector(dvd, unit);
126 }
127
128 /** {@inheritDoc} */
129 @Override
130 protected final MutableTimeVector instantiateMutableType(final DoubleVectorData dvd, final TimeUnit unit)
131 {
132 return new MutableTimeVector(dvd, unit);
133 }
134
135 /** {@inheritDoc} */
136 @Override
137 protected final Time instantiateScalar(final double value, final TimeUnit unit)
138 {
139 return new Time(value, unit);
140 }
141
142 /** {@inheritDoc} */
143 @Override
144 public final TimeVector toDense()
145 {
146 return this.data.isDense() ? (TimeVector) this : instantiateTypeAbs(this.data.toDense(), getUnit());
147 }
148
149 /** {@inheritDoc} */
150 @Override
151 public final TimeVector toSparse()
152 {
153 return this.data.isSparse() ? (TimeVector) this : instantiateTypeAbs(this.data.toSparse(), getUnit());
154 }
155
156 /**
157 * Return an array of Time Scalars from this vector.
158 * @return Time[]; an array of Time Scalars from this vector
159 * @throws RuntimeException wrapping a ValueException on error getting one of the values
160 */
161 public Time[] toArray()
162 {
163 Time[] array = new Time[size()];
164 for (int i = 0; i < size(); i++)
165 {
166 try
167 {
168 array[i] = get(i);
169 }
170 catch (ValueException exception)
171 {
172 throw new RuntimeException(exception);
173 }
174 }
175 return array;
176 }
177
178 }