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