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