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