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