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