View Javadoc
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-2018 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 U; the unit of the new Absolute Immutable Double TimeVector
33       * @param 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; the values of the entries in the new Absolute Immutable Double TimeVector
44       * @param unit U; the unit of the new Absolute Immutable Double TimeVector
45       * @param 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 DoubleScalar.Rel&lt;U&gt;[]; the values of the entries in the new Absolute Immutable Double TimeVector
56       * @param 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; the values of the entries in the new Absolute Immutable Double TimeVector
67       * @param 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 DoubleScalar.Rel&lt;U&gt;[]; the values of the entries in the new Absolute Sparse Mutable Double TimeVector
78       * @param length the size of the vector
79       * @param storageType the data type to use (e.g., DENSE or SPARSE)
80       * @throws ValueException when values has zero entries
81       */
82      public TimeVector(final SortedMap<Integer, Time> values, final int length, final StorageType storageType)
83              throws ValueException
84      {
85          super(values, length, storageType);
86      }
87  
88      /**
89       * Construct a new Absolute Immutable Double TimeVector.
90       * @param values Map; the map of indexes to values of the Absolute Sparse Mutable Double TimeVector
91       * @param unit U; the unit of the new Absolute Sparse Mutable Double TimeVector
92       * @param length the size of the vector
93       * @param storageType the data type to use (e.g., DENSE or SPARSE)
94       * @throws ValueException when values is null
95       */
96      public TimeVector(final SortedMap<Integer, Double> values, final TimeUnit unit, final int length,
97              final StorageType storageType) throws ValueException
98      {
99          super(values, unit, length, storageType);
100     }
101 
102     /**
103      * Construct a new Absolute Immutable Double TimeVector.
104      * @param data an internal data object
105      * @param unit the unit
106      */
107     TimeVector(final DoubleVectorData data, final TimeUnit unit)
108     {
109         super(data, unit);
110     }
111 
112     /** {@inheritDoc} */
113     @Override
114     protected final TimeVector instantiateTypeAbs(final DoubleVectorData dvd, final TimeUnit unit)
115     {
116         return new TimeVector(dvd, unit);
117     }
118 
119     /** {@inheritDoc} */
120     @Override
121     protected final DurationVector instantiateTypeRel(final DoubleVectorData dvd, final DurationUnit unit)
122     {
123         return new DurationVector(dvd, unit);
124     }
125 
126     /** {@inheritDoc} */
127     @Override
128     protected final MutableTimeVector instantiateMutableType(final DoubleVectorData dvd, final TimeUnit unit)
129     {
130         return new MutableTimeVector(dvd, unit);
131     }
132 
133     /** {@inheritDoc} */
134     @Override
135     protected final Time instantiateScalar(final double value, final TimeUnit unit)
136     {
137         return new Time(value, unit);
138     }
139 
140     /** {@inheritDoc} */
141     @Override
142     public final TimeVector toDense()
143     {
144         return this.data.isDense() ? (TimeVector) this : instantiateTypeAbs(this.data.toDense(), getUnit());
145     }
146 
147     /** {@inheritDoc} */
148     @Override
149     public final TimeVector toSparse()
150     {
151         return this.data.isSparse() ? (TimeVector) this : instantiateTypeAbs(this.data.toSparse(), getUnit());
152     }
153 
154     /**
155      * Return an array of Time Scalars from this vector.
156      * @return Time[]; an array of Time Scalars from this vector
157      * @throws RuntimeException wrapping a ValueException on error getting one of the values
158      */
159     public Time[] toArray()
160     {
161         Time[] array = new Time[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 }