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