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