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