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