1 package org.djunits.value.vdouble.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.vdouble.scalar.Money;
10
11 /**
12 * Mutable Double MoneyVector, a vector of values with a MoneyUnit.
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 MutableMoneyVector extends AbstractMutableDoubleVectorRel<MoneyUnit, MoneyVector, MutableMoneyVector, Money>
23 {
24 /** */
25 private static final long serialVersionUID = 20151109L;
26
27 /**
28 * Construct a new Relative Immutable Double MoneyVector.
29 * @param values double[]; the values of the entries in the new Relative Immutable Double MoneyVector
30 * @param unit MoneyUnit; the unit of the new Relative Immutable Double MoneyVector
31 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
32 * @throws ValueException when values is null
33 */
34 public MutableMoneyVector(final double[] values, final MoneyUnit unit, final StorageType storageType) throws ValueException
35 {
36 super(values, unit, storageType);
37 }
38
39 /**
40 * Construct a new Relative Immutable Double MoneyVector.
41 * @param values List<Double>; the values of the entries in the new Relative Immutable Double MoneyVector
42 * @param unit MoneyUnit; the unit of the new Relative Immutable Double MoneyVector
43 * @param storageType StorageType; the data type to use (e.g., DENSE or SPARSE)
44 * @throws ValueException when values is null
45 */
46 public MutableMoneyVector(final List<Double> values, final MoneyUnit unit, final StorageType storageType)
47 throws ValueException
48 {
49 super(values, unit, storageType);
50 }
51
52 /**
53 * Construct a new Relative Immutable Double MoneyVector.
54 * @param values Money[]; the values of the entries in the new Relative Immutable Double MoneyVector
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 MutableMoneyVector(final Money[] values, final StorageType storageType) throws ValueException
59 {
60 super(values, storageType);
61 }
62
63 /**
64 * Construct a new Relative Immutable Double MoneyVector.
65 * @param values List<Money>; the values of the entries in the new Relative Immutable Double MoneyVector
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 MutableMoneyVector(final List<Money> values, final StorageType storageType) throws ValueException
70 {
71 super(values, storageType);
72 }
73
74 /**
75 * Construct a new Relative Immutable Double MoneyVector.
76 * @param values SortedMap<Integer, Money>; the values of the entries in the new Relative Sparse Mutable Double
77 * MoneyVector
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 MutableMoneyVector(final SortedMap<Integer, Money> 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 MoneyVector.
90 * @param values SortedMap<Integer, Double>; the map of indexes to values of the Relative Sparse Mutable Double
91 * MoneyVector
92 * @param unit MoneyUnit; the unit of the new Relative Sparse Mutable Double MoneyVector
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 MutableMoneyVector(final SortedMap<Integer, Double> 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 DoubleVectorData; an internal data object
105 * @param unit MoneyUnit; the unit
106 */
107 MutableMoneyVector(final DoubleVectorData data, final MoneyUnit unit)
108 {
109 super(data, unit);
110 }
111
112 /** {@inheritDoc} */
113 @Override
114 protected final MoneyVector instantiateType(final DoubleVectorData dvd, final MoneyUnit unit)
115 {
116 return new MoneyVector(dvd, unit);
117 }
118
119 /** {@inheritDoc} */
120 @Override
121 protected final MutableMoneyVector instantiateMutableType(final DoubleVectorData dvd, final MoneyUnit unit)
122 {
123 return new MutableMoneyVector(dvd, unit);
124 }
125
126 /** {@inheritDoc} */
127 @Override
128 protected final Money instantiateScalar(final double value, final MoneyUnit unit)
129 {
130 return new Money(value, unit);
131 }
132
133 /** {@inheritDoc} */
134 @Override
135 public final MutableMoneyVector toDense()
136 {
137 return this.data.isDense() ? (MutableMoneyVector) this : instantiateMutableType(this.data.toDense(), getUnit());
138 }
139
140 /** {@inheritDoc} */
141 @Override
142 public final MutableMoneyVector toSparse()
143 {
144 return this.data.isSparse() ? (MutableMoneyVector) this : instantiateMutableType(this.data.toSparse(), getUnit());
145 }
146
147 /**
148 * Return an array of Money Scalars from this vector.
149 * @return Money[]; an array of Money Scalars from this vector
150 * @throws RuntimeException wrapping a ValueException on error getting one of the values
151 */
152 public Money[] toArray()
153 {
154 Money[] array = new Money[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 }