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.value.StorageType;
8   import org.djunits.value.ValueException;
9   import org.djunits.value.vdouble.scalar.Duration;
10  
11  /**
12   * Immutable Relative Duration Vector.
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://djunits.org/docs/license.html">DJUNITS License</a>.
16   * <p>
17   * $LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial
18   * version Sep 5, 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 DurationVector extends AbstractDoubleVectorRel<DurationUnit, DurationVector, MutableDurationVector, Duration>
23  {
24      /** */
25      private static final long serialVersionUID = 20151006L;
26  
27      /**
28       * Construct a new Relative Immutable Double DurationVector.
29       * @param values double[]; the values of the entries in the new Relative Immutable Double DurationVector
30       * @param unit DurationUnit; the unit of the new Relative Immutable Double DurationVector
31       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
32       * @throws ValueException when values is null
33       */
34      public DurationVector(final double[] values, final DurationUnit unit, final StorageType storageType) throws ValueException
35      {
36          super(values, unit, storageType);
37      }
38  
39      /**
40       * Construct a new Relative Immutable Double DurationVector.
41       * @param values List&lt;Double&gt;; the values of the entries in the new Relative Immutable Double DurationVector
42       * @param unit DurationUnit; the unit of the new Relative Immutable Double DurationVector
43       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
44       * @throws ValueException when values is null
45       */
46      public DurationVector(final List<Double> values, final DurationUnit unit, final StorageType storageType)
47              throws ValueException
48      {
49          super(values, unit, storageType);
50      }
51  
52      /**
53       * Construct a new Relative Immutable Double DurationVector.
54       * @param values Duration[]; the values of the entries in the new Relative Immutable Double DurationVector
55       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
56       * @throws ValueException when values has zero entries
57       */
58      public DurationVector(final Duration[] values, final StorageType storageType) throws ValueException
59      {
60          super(values, storageType);
61      }
62  
63      /**
64       * Construct a new Relative Immutable Double DurationVector.
65       * @param values List&lt;Duration&gt;; the values of the entries in the new Relative Immutable Double DurationVector
66       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
67       * @throws ValueException when values has zero entries
68       */
69      public DurationVector(final List<Duration> values, final StorageType storageType) throws ValueException
70      {
71          super(values, storageType);
72      }
73  
74      /**
75       * Construct a new Relative Immutable Double DurationVector.
76       * @param values SortedMap&lt;Integer, Duration&gt;; the values of the entries in the new Relative Sparse Mutable Double
77       *            DurationVector
78       * @param length int; the size of the vector
79       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
80       * @throws ValueException when values has zero entries
81       */
82      public DurationVector(final SortedMap<Integer, Duration> values, final int length, final StorageType storageType)
83              throws ValueException
84      {
85          super(values, length, storageType);
86      }
87  
88      /**
89       * Construct a new Relative Immutable Double DurationVector.
90       * @param values SortedMap&lt;Integer, Double&gt;; the map of indexes to values of the Relative Sparse Mutable Double
91       *            DurationVector
92       * @param unit DurationUnit; the unit of the new Relative Sparse Mutable Double DurationVector
93       * @param length int; the size of the vector
94       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
95       * @throws ValueException when values is null
96       */
97      public DurationVector(final SortedMap<Integer, Double> values, final DurationUnit unit, final int length,
98              final StorageType storageType) throws ValueException
99      {
100         super(values, unit, length, storageType);
101     }
102 
103     /**
104      * Construct a new Relative Immutable Double DurationVector.
105      * @param data DoubleVectorData; an internal data object
106      * @param unit DurationUnit; the unit
107      */
108     DurationVector(final DoubleVectorData data, final DurationUnit unit)
109     {
110         super(data, unit);
111     }
112 
113     /** {@inheritDoc} */
114     @Override
115     protected final DurationVector instantiateType(final DoubleVectorData dvd, final DurationUnit unit)
116     {
117         return new DurationVector(dvd, unit);
118     }
119 
120     /** {@inheritDoc} */
121     @Override
122     protected final MutableDurationVector instantiateMutableType(final DoubleVectorData dvd, final DurationUnit unit)
123     {
124         return new MutableDurationVector(dvd, unit);
125     }
126 
127     /** {@inheritDoc} */
128     @Override
129     protected final Duration instantiateScalar(final double value, final DurationUnit unit)
130     {
131         return new Duration(value, unit);
132     }
133 
134     /** {@inheritDoc} */
135     @Override
136     public final DurationVector toDense()
137     {
138         return this.data.isDense() ? (DurationVector) this : instantiateType(this.data.toDense(), getUnit());
139     }
140 
141     /** {@inheritDoc} */
142     @Override
143     public final DurationVector toSparse()
144     {
145         return this.data.isSparse() ? (DurationVector) this : instantiateType(this.data.toSparse(), getUnit());
146     }
147 
148     /**
149      * Return an array of Duration Scalars from this vector.
150      * @return Duration[]; an array of Duration Scalars from this vector
151      * @throws RuntimeException wrapping a ValueException on error getting one of the values
152      */
153     public Duration[] toArray()
154     {
155         Duration[] array = new Duration[size()];
156         for (int i = 0; i < size(); i++)
157         {
158             try
159             {
160                 array[i] = get(i);
161             }
162             catch (ValueException exception)
163             {
164                 throw new RuntimeException(exception);
165             }
166         }
167         return array;
168     }
169 
170 }