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