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