View Javadoc
1   package org.djunits.value.vfloat.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.vfloat.scalar.FloatMoneyPerEnergy;
10  
11  /**
12   * Mutable Float MoneyPerEnergyVector, a vector of values with a MoneyPerEnergyUnit.
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://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 MutableFloatMoneyPerEnergyVector extends AbstractMutableFloatVectorRel<MoneyPerEnergyUnit,
23          FloatMoneyPerEnergyVector, MutableFloatMoneyPerEnergyVector, FloatMoneyPerEnergy>
24  {
25      /** */
26      private static final long serialVersionUID = 20151109L;
27  
28      /**
29       * Construct a new Relative Immutable Float MoneyPerEnergyVector.
30       * @param values float[]; the values of the entries in the new Relative Immutable Float MoneyPerEnergyVector
31       * @param unit MoneyPerEnergyUnit; the unit of the new Relative Immutable Float MoneyPerEnergyVector
32       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
33       * @throws ValueException when values is null
34       */
35      public MutableFloatMoneyPerEnergyVector(final float[] 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 Float MoneyPerEnergyVector.
43       * @param values List&lt;Float&gt;; the values of the entries in the new Relative Immutable Float MoneyPerEnergyVector
44       * @param unit MoneyPerEnergyUnit; the unit of the new Relative Immutable Float MoneyPerEnergyVector
45       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
46       * @throws ValueException when values is null
47       */
48      public MutableFloatMoneyPerEnergyVector(final List<Float> values, final MoneyPerEnergyUnit unit,
49              final StorageType storageType) throws ValueException
50      {
51          super(values, unit, storageType);
52      }
53  
54      /**
55       * Construct a new Relative Immutable Float MoneyPerEnergyVector.
56       * @param values FloatMoneyPerEnergy[]; the values of the entries in the new Relative Immutable Float MoneyPerEnergyVector
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 MutableFloatMoneyPerEnergyVector(final FloatMoneyPerEnergy[] values, final StorageType storageType)
61              throws ValueException
62      {
63          super(values, storageType);
64      }
65  
66      /**
67       * Construct a new Relative Immutable Float MoneyPerEnergyVector.
68       * @param values List&lt;FloatMoneyPerEnergy&gt;; the values of the entries in the new Relative Immutable Float
69       *            MoneyPerEnergyVector
70       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
71       * @throws ValueException when values has zero entries
72       */
73      public MutableFloatMoneyPerEnergyVector(final List<FloatMoneyPerEnergy> values, final StorageType storageType)
74              throws ValueException
75      {
76          super(values, storageType);
77      }
78  
79      /**
80       * Construct a new Relative Immutable Float MoneyPerEnergyVector.
81       * @param values SortedMap&lt;Integer, FloatMoneyPerEnergy&gt;; the values of the entries in the new Relative Sparse Mutable
82       *            Float MoneyPerEnergyVector
83       * @param length int; the size of the vector
84       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
85       * @throws ValueException when values has zero entries
86       */
87      public MutableFloatMoneyPerEnergyVector(final SortedMap<Integer, FloatMoneyPerEnergy> values, final int length,
88              final StorageType storageType) throws ValueException
89      {
90          super(values, length, storageType);
91      }
92  
93      /**
94       * Construct a new Relative Immutable Float MoneyPerEnergyVector.
95       * @param values SortedMap&lt;Integer, Float&gt;; the map of indexes to values of the Relative Sparse Mutable Float
96       *            MoneyPerEnergyVector
97       * @param unit MoneyPerEnergyUnit; the unit of the new Relative Sparse Mutable Float MoneyPerEnergyVector
98       * @param length int; the size of the vector
99       * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
100      * @throws ValueException when values is null
101      */
102     public MutableFloatMoneyPerEnergyVector(final SortedMap<Integer, Float> values, final MoneyPerEnergyUnit unit,
103             final int length, final StorageType storageType) throws ValueException
104     {
105         super(values, unit, length, storageType);
106     }
107 
108     /**
109      * @param data FloatVectorData; an internal data object
110      * @param unit MoneyPerEnergyUnit; the unit
111      */
112     MutableFloatMoneyPerEnergyVector(final FloatVectorData data, final MoneyPerEnergyUnit unit)
113     {
114         super(data, unit);
115     }
116 
117     /** {@inheritDoc} */
118     @Override
119     protected final FloatMoneyPerEnergyVector instantiateType(final FloatVectorData dvd, final MoneyPerEnergyUnit unit)
120     {
121         return new FloatMoneyPerEnergyVector(dvd, unit);
122     }
123 
124     /** {@inheritDoc} */
125     @Override
126     protected final MutableFloatMoneyPerEnergyVector instantiateMutableType(final FloatVectorData dvd,
127             final MoneyPerEnergyUnit unit)
128     {
129         return new MutableFloatMoneyPerEnergyVector(dvd, unit);
130     }
131 
132     /** {@inheritDoc} */
133     @Override
134     protected final FloatMoneyPerEnergy instantiateScalar(final float value, final MoneyPerEnergyUnit unit)
135     {
136         return new FloatMoneyPerEnergy(value, unit);
137     }
138 
139     /** {@inheritDoc} */
140     @Override
141     public final MutableFloatMoneyPerEnergyVector toDense()
142     {
143         return this.data.isDense() ? (MutableFloatMoneyPerEnergyVector) this
144                 : instantiateMutableType(this.data.toDense(), getUnit());
145     }
146 
147     /** {@inheritDoc} */
148     @Override
149     public final MutableFloatMoneyPerEnergyVector toSparse()
150     {
151         return this.data.isSparse() ? (MutableFloatMoneyPerEnergyVector) this
152                 : instantiateMutableType(this.data.toSparse(), getUnit());
153     }
154 
155     /**
156      * Return an array of FloatMoneyPerEnergy Scalars from this vector.
157      * @return FloatMoneyPerEnergy[]; an array of FloatMoneyPerEnergy Scalars from this vector
158      * @throws RuntimeException wrapping a ValueException on error getting one of the values
159      */
160     public FloatMoneyPerEnergy[] toArray()
161     {
162         FloatMoneyPerEnergy[] array = new FloatMoneyPerEnergy[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 }