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