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