1 package org.djunits.value.vdouble.vector;
2
3 import java.util.List;
4 import java.util.SortedMap;
5
6 import org.djunits.unit.LengthUnit;
7 import org.djunits.value.StorageType;
8 import org.djunits.value.ValueException;
9 import org.djunits.value.vdouble.scalar.Length;
10
11 /**
12 * Immutable Relative Length Vector.
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://djunits.org/docs/license.html">DJUNITS License</a>.
16 * <p>
17 * $LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial
18 * version Sep 5, 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 LengthVector extends AbstractDoubleVectorRel<LengthUnit, LengthVector, MutableLengthVector, Length>
23 {
24 /** */
25 private static final long serialVersionUID = 20151006L;
26
27 /**
28 * Construct a new Relative Immutable Double LengthVector.
29 * @param values double[]; the values of the entries in the new Relative Immutable Double LengthVector
30 * @param unit U; the unit of the new Relative Immutable Double LengthVector
31 * @param storageType the data type to use (e.g., DENSE or SPARSE)
32 * @throws ValueException when values is null
33 */
34 public LengthVector(final double[] values, final LengthUnit unit, final StorageType storageType) throws ValueException
35 {
36 super(values, unit, storageType);
37 }
38
39 /**
40 * Construct a new Relative Immutable Double LengthVector.
41 * @param values List; the values of the entries in the new Relative Immutable Double LengthVector
42 * @param unit U; the unit of the new Relative Immutable Double LengthVector
43 * @param storageType the data type to use (e.g., DENSE or SPARSE)
44 * @throws ValueException when values is null
45 */
46 public LengthVector(final List<Double> values, final LengthUnit unit, final StorageType storageType) throws ValueException
47 {
48 super(values, unit, storageType);
49 }
50
51 /**
52 * Construct a new Relative Immutable Double LengthVector.
53 * @param values DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Immutable Double LengthVector
54 * @param storageType the data type to use (e.g., DENSE or SPARSE)
55 * @throws ValueException when values has zero entries
56 */
57 public LengthVector(final Length[] values, final StorageType storageType) throws ValueException
58 {
59 super(values, storageType);
60 }
61
62 /**
63 * Construct a new Relative Immutable Double LengthVector.
64 * @param values List; the values of the entries in the new Relative Immutable Double LengthVector
65 * @param storageType the data type to use (e.g., DENSE or SPARSE)
66 * @throws ValueException when values has zero entries
67 */
68 public LengthVector(final List<Length> values, final StorageType storageType) throws ValueException
69 {
70 super(values, storageType);
71 }
72
73 /**
74 * Construct a new Relative Immutable Double LengthVector.
75 * @param values DoubleScalar.Rel<U>[]; the values of the entries in the new Relative Sparse Mutable Double
76 * LengthVector
77 * @param length the size of the vector
78 * @param storageType the data type to use (e.g., DENSE or SPARSE)
79 * @throws ValueException when values has zero entries
80 */
81 public LengthVector(final SortedMap<Integer, Length> values, final int length, final StorageType storageType)
82 throws ValueException
83 {
84 super(values, length, storageType);
85 }
86
87 /**
88 * Construct a new Relative Immutable Double LengthVector.
89 * @param values Map; the map of indexes to values of the Relative Sparse Mutable Double LengthVector
90 * @param unit U; the unit of the new Relative Sparse Mutable Double LengthVector
91 * @param length the size of the vector
92 * @param storageType the data type to use (e.g., DENSE or SPARSE)
93 * @throws ValueException when values is null
94 */
95 public LengthVector(final SortedMap<Integer, Double> values, final LengthUnit unit, final int length,
96 final StorageType storageType) throws ValueException
97 {
98 super(values, unit, length, storageType);
99 }
100
101 /**
102 * Construct a new Relative Immutable Double LengthVector.
103 * @param data an internal data object
104 * @param unit the unit
105 */
106 LengthVector(final DoubleVectorData data, final LengthUnit unit)
107 {
108 super(data, unit);
109 }
110
111 /** {@inheritDoc} */
112 @Override
113 protected final LengthVector instantiateType(final DoubleVectorData dvd, final LengthUnit unit)
114 {
115 return new LengthVector(dvd, unit);
116 }
117
118 /** {@inheritDoc} */
119 @Override
120 protected final MutableLengthVector instantiateMutableType(final DoubleVectorData dvd, final LengthUnit unit)
121 {
122 return new MutableLengthVector(dvd, unit);
123 }
124
125 /** {@inheritDoc} */
126 @Override
127 protected final Length instantiateScalar(final double value, final LengthUnit unit)
128 {
129 return new Length(value, unit);
130 }
131
132 /** {@inheritDoc} */
133 @Override
134 public final LengthVector toDense()
135 {
136 return this.data.isDense() ? (LengthVector) this : instantiateType(this.data.toDense(), getUnit());
137 }
138
139 /** {@inheritDoc} */
140 @Override
141 public final LengthVector toSparse()
142 {
143 return this.data.isSparse() ? (LengthVector) this : instantiateType(this.data.toSparse(), getUnit());
144 }
145
146 /**
147 * Return an array of Length Scalars from this vector.
148 * @return Length[]; an array of Length Scalars from this vector
149 * @throws RuntimeException wrapping a ValueException on error getting one of the values
150 */
151 public Length[] toArray()
152 {
153 Length[] array = new Length[size()];
154 for (int i = 0; i < size(); i++)
155 {
156 try
157 {
158 array[i] = get(i);
159 }
160 catch (ValueException exception)
161 {
162 throw new RuntimeException(exception);
163 }
164 }
165 return array;
166 }
167
168 }