DoubleMatrixUtil (DJUNITS 3.01.04 API)

java.lang.Object
- org.djunits.value.vdouble.matrix.DoubleMatrixUtil

```
public final class DoubleMatrixUtil
extends Object
```
Class to instantiate any DoubleMatrix based on the provided unit.
Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Aug 11, 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <U extends Unit<U>,S extends AbstractDoubleMatrix<U,S>> S`	`instantiate(double[][] value, U unit, StorageType storageType)` Instantiate the DoubleMatrix based on its unit.
`static <S extends AbstractDoubleMatrix<?,S>> S`	`instantiateAnonymous(double[][] value, Unit<?> unit, StorageType storageType)` Instantiate the DoubleMatrix based on its unit.
`static <S extends AbstractDoubleMatrix<?,S>> S`	`instantiateAnonymousSI(double[][] si, Unit<?> displayUnit, StorageType storageType)` Instantiate the DoubleMatrix based on its unit.
`static <U extends Unit<U>,S extends AbstractDoubleMatrix<U,S>> S`	`instantiateSI(double[][] si, U displayUnit, StorageType storageType)` Instantiate the DoubleMatrix based on its unit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instantiate

public static <U extends Unit<U>,S extends AbstractDoubleMatrix<U,S>> S instantiate(double[][] value,
                                                                                    U unit,
                                                                                    StorageType storageType)
                                                                             throws ValueException

Instantiate the DoubleMatrix based on its unit. Rigid check on types for the compiler.

Type Parameters:: U - the unit; S - the return type
Parameters:: value - double[][]; the value; unit - U; the unit in which the value is expressed; storageType - StorageType; whether the vector is SPARSE or DENSE
Returns:: an instantiated DoubleMatrix with the value expressed in the unit
Throws:: ValueException - on vector init error

instantiateAnonymous

public static <S extends AbstractDoubleMatrix<?,S>> S instantiateAnonymous(double[][] value,
                                                                           Unit<?> unit,
                                                                           StorageType storageType)
                                                                    throws ValueException

Instantiate the DoubleMatrix based on its unit. Loose check for types on the compiler. This allows the unit to be specified as a Unit<?> type.
Note that it is possible to make mistakes with anonymous units. The following does compile:

 MoneyPerLengthUnit mlu = new MoneyPerLengthUnit(MoneyUnit.USD, LengthUnit.METER, "$/m", "$/m");
 
 MoneyPerArea mpa = DoubleMatrixUtil.instantiateAnonymous(10.0, mlu);

Type Parameters:: S - the return type
Parameters:: value - double[][]; the value; unit - Unit<?>; the unit in which the value is expressed; storageType - StorageType; whether the vector is SPARSE or DENSE
Returns:: an instantiated DoubleMatrix with the value expressed in the unit
Throws:: ValueException - on vector init error

instantiateSI

public static <U extends Unit<U>,S extends AbstractDoubleMatrix<U,S>> S instantiateSI(double[][] si,
                                                                                      U displayUnit,
                                                                                      StorageType storageType)
                                                                               throws ValueException

Instantiate the DoubleMatrix based on its unit.

Type Parameters:: U - the unit; S - the return type
Parameters:: si - double[][]; the value in SI units; displayUnit - U; the unit in which the value is expressed; storageType - StorageType; whether the vector is SPARSE or DENSE
Returns:: an instantiated DoubleMatrix with the value expressed in the unit
Throws:: ValueException - on vector init error

instantiateAnonymousSI

public static <S extends AbstractDoubleMatrix<?,S>> S instantiateAnonymousSI(double[][] si,
                                                                             Unit<?> displayUnit,
                                                                             StorageType storageType)
                                                                      throws ValueException

 MoneyPerLengthUnit mlu = new MoneyPerLengthUnit(MoneyUnit.USD, LengthUnit.METER, "$/m", "$/m");
 
 MoneyPerArea mpa = DoubleMatrixUtil.instantiateAnonymousSI(10.0, mlu);

Type Parameters:: S - the return type
Parameters:: si - double[][]; the value in SI units; displayUnit - Unit<?>; the unit in which the value is expressed; storageType - StorageType; whether the vector is SPARSE or DENSE
Returns:: an instantiated DoubleMatrix with the value expressed in the unit
Throws:: ValueException - on vector init error

Class DoubleMatrixUtil