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   * Mutable 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 MutableTimeVector
24          extends AbstractMutableDoubleVectorAbs<TimeUnit, DurationUnit, TimeVector, DurationVector, MutableTimeVector, Time>
25  {
26      /** */
27      private static final long serialVersionUID = 20151003L;
28  
29      /**
30       * Construct a new Absolute Mutable Double TimeVector.
31       * @param values double[]; the values of the entries in the new Absolute Mutable Double TimeVector
32       * @param unit TimeUnit; the unit of the new Absolute Mutable 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 MutableTimeVector(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 Mutable Double TimeVector.
43       * @param values List&lt;Double&gt;; the values of the entries in the new Absolute Mutable Double TimeVector
44       * @param unit TimeUnit; the unit of the new Absolute Mutable 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 MutableTimeVector(final List<Double> values, final TimeUnit unit, final StorageType storageType)
49              throws ValueException
50      {
51          super(values, unit, storageType);
52      }
53  
54      /**
55       * Construct a new Absolute Mutable Double TimeVector.
56       * @param values Time[]; the values of the entries in the new Absolute Mutable Double TimeVector
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 MutableTimeVector(final Time[] values, final StorageType storageType) throws ValueException
61      {
62          super(values, storageType);
63      }
64  
65      /**
66       * Construct a new Absolute Mutable Double TimeVector.
67       * @param values List&lt;Time&gt;; the values of the entries in the new Absolute Mutable Double TimeVector
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 MutableTimeVector(final List<Time> values, final StorageType storageType) throws ValueException
72      {
73          super(values, storageType);
74      }
75  
76      /**
77       * Construct a new Absolute Mutable Double TimeVector.
78       * @param values SortedMap&lt;Integer, Time&gt;; the values of the entries in the new Absolute Sparse Mutable Double
79       *            TimeVector
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 MutableTimeVector(final SortedMap<Integer, Time> values, final int length, final StorageType storageType)
85              throws ValueException
86      {
87          super(values, length, storageType);
88      }
89  
90      /**
91       * Construct a new Absolute Mutable Double TimeVector.
92       * @param values SortedMap&lt;Integer, Double&gt;; the map of indexes to values of the Absolute Sparse Mutable Double
93       *            TimeVector
94       * @param unit TimeUnit; the unit of the new Absolute Sparse Mutable Double TimeVector
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 MutableTimeVector(final SortedMap<Integer, Double> values, final TimeUnit unit, final int length,
100             final StorageType storageType) throws ValueException
101     {
102         super(values, unit, length, storageType);
103     }
104 
105     /**
106      * Construct a new Absolute Mutable Double TimeVector.
107      * @param data DoubleVectorData; an internal data object
108      * @param unit TimeUnit; the unit
109      */
110     MutableTimeVector(final DoubleVectorData data, final TimeUnit unit)
111     {
112         super(data, unit);
113     }
114 
115     /** {@inheritDoc} */
116     @Override
117     protected final TimeVector instantiateTypeAbs(final DoubleVectorData dvd, final TimeUnit unit)
118     {
119         return new TimeVector(dvd, unit);
120     }
121 
122     /** {@inheritDoc} */
123     @Override
124     protected final DurationVector instantiateTypeRel(final DoubleVectorData dvd, final DurationUnit unit)
125     {
126         return new DurationVector(dvd, unit);
127     }
128 
129     /** {@inheritDoc} */
130     @Override
131     protected final MutableTimeVector instantiateMutableType(final DoubleVectorData dvd, final TimeUnit unit)
132     {
133         return new MutableTimeVector(dvd, unit);
134     }
135 
136     /** {@inheritDoc} */
137     @Override
138     protected final Time instantiateScalar(final double value, final TimeUnit unit)
139     {
140         return new Time(value, unit);
141     }
142 
143     /** {@inheritDoc} */
144     @Override
145     public final MutableTimeVector toDense()
146     {
147         return this.data.isDense() ? (MutableTimeVector) this : instantiateMutableType(this.data.toDense(), getUnit());
148     }
149 
150     /** {@inheritDoc} */
151     @Override
152     public final MutableTimeVector toSparse()
153     {
154         return this.data.isSparse() ? (MutableTimeVector) this : instantiateMutableType(this.data.toSparse(), getUnit());
155     }
156 
157     /**
158      * Return an array of Time Scalars from this vector.
159      * @return Time[]; an array of Time Scalars from this vector
160      * @throws RuntimeException wrapping a ValueException on error getting one of the values
161      */
162     public Time[] toArray()
163     {
164         Time[] array = new Time[size()];
165         for (int i = 0; i < size(); i++)
166         {
167             try
168             {
169                 array[i] = get(i);
170             }
171             catch (ValueException exception)
172             {
173                 throw new RuntimeException(exception);
174             }
175         }
176         return array;
177     }
178 
179 }