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   * 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 FloatLengthVector
23          extends AbstractFloatVectorRel<LengthUnit, FloatLengthVector, MutableFloatLengthVector, FloatLength>
24  {
25      /** */
26      private static final long serialVersionUID = 20151006L;
27  
28      /**
29       * Construct a new Relative Immutable FloatLengthVector.
30       * @param values float[]; the values of the entries in the new Relative Immutable FloatLengthVector
31       * @param unit U; the unit of the new Relative Immutable FloatLengthVector
32       * @param storageType the data type to use (e.g., DENSE or SPARSE)
33       * @throws ValueException when values is null
34       */
35      public FloatLengthVector(final float[] values, final LengthUnit unit, final StorageType storageType) throws ValueException
36      {
37          super(values, unit, storageType);
38      }
39  
40      /**
41       * Construct a new Relative Immutable FloatLengthVector.
42       * @param values List; the values of the entries in the new Relative Immutable FloatLengthVector
43       * @param unit U; the unit of the new Relative Immutable FloatLengthVector
44       * @param storageType the data type to use (e.g., DENSE or SPARSE)
45       * @throws ValueException when values is null
46       */
47      public FloatLengthVector(final List<Float> values, final LengthUnit unit, final StorageType storageType)
48              throws ValueException
49      {
50          super(values, unit, storageType);
51      }
52  
53      /**
54       * Construct a new Relative Immutable FloatLengthVector.
55       * @param values FloatScalar.Rel&lt;U&gt;[]; the values of the entries in the new Relative Immutable FloatLengthVector
56       * @param storageType the data type to use (e.g., DENSE or SPARSE)
57       * @throws ValueException when values has zero entries
58       */
59      public FloatLengthVector(final FloatLength[] values, final StorageType storageType) throws ValueException
60      {
61          super(values, storageType);
62      }
63  
64      /**
65       * Construct a new Relative Immutable FloatLengthVector.
66       * @param values List; the values of the entries in the new Relative Immutable FloatLengthVector
67       * @param storageType the data type to use (e.g., DENSE or SPARSE)
68       * @throws ValueException when values has zero entries
69       */
70      public FloatLengthVector(final List<FloatLength> values, final StorageType storageType) throws ValueException
71      {
72          super(values, storageType);
73      }
74  
75      /**
76       * Construct a new Relative Immutable FloatLengthVector.
77       * @param values FloatScalar.Rel&lt;U&gt;[]; the values of the entries in the new Relative Sparse Mutable FloatLengthVector
78       * @param length the size of the vector
79       * @param storageType the data type to use (e.g., DENSE or SPARSE)
80       * @throws ValueException when values has zero entries
81       */
82      public FloatLengthVector(final SortedMap<Integer, FloatLength> 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 FloatLengthVector.
90       * @param values Map; the map of indexes to values of the Relative Sparse Mutable FloatLengthVector
91       * @param unit U; the unit of the new Relative Sparse Mutable FloatLengthVector
92       * @param length the size of the vector
93       * @param storageType the data type to use (e.g., DENSE or SPARSE)
94       * @throws ValueException when values is null
95       */
96      public FloatLengthVector(final SortedMap<Integer, Float> values, final LengthUnit unit, final int length,
97              final StorageType storageType) throws ValueException
98      {
99          super(values, unit, length, storageType);
100     }
101 
102     /**
103      * Construct a new Relative Immutable FloatLengthVector.
104      * @param data an internal data object
105      * @param unit the unit
106      */
107     FloatLengthVector(final FloatVectorData data, final LengthUnit unit)
108     {
109         super(data, unit);
110     }
111 
112     /** {@inheritDoc} */
113     @Override
114     protected final FloatLengthVector instantiateType(final FloatVectorData dvd, final LengthUnit unit)
115     {
116         return new FloatLengthVector(dvd, unit);
117     }
118 
119     /** {@inheritDoc} */
120     @Override
121     protected final MutableFloatLengthVector instantiateMutableType(final FloatVectorData dvd, final LengthUnit unit)
122     {
123         return new MutableFloatLengthVector(dvd, unit);
124     }
125 
126     /** {@inheritDoc} */
127     @Override
128     protected final FloatLength instantiateScalar(final float value, final LengthUnit unit)
129     {
130         return new FloatLength(value, unit);
131     }
132 
133     /** {@inheritDoc} */
134     @Override
135     public final FloatLengthVector toDense()
136     {
137         return this.data.isDense() ? (FloatLengthVector) this : instantiateType(this.data.toDense(), getUnit());
138     }
139 
140     /** {@inheritDoc} */
141     @Override
142     public final FloatLengthVector toSparse()
143     {
144         return this.data.isSparse() ? (FloatLengthVector) this : instantiateType(this.data.toSparse(), getUnit());
145     }
146 
147     /**
148      * Return an array of FloatLength Scalars from this vector.
149      * @return FloatLength[]; an array of FloatLength Scalars from this vector
150      * @throws RuntimeException wrapping a ValueException on error getting one of the values
151      */
152     public FloatLength[] toArray()
153     {
154         FloatLength[] array = new FloatLength[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 }