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