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