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