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