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