Package org.djunits.vecmat.dn

Class VectorN<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

java.lang.Object

org.djunits.vecmat.def.VectorMatrix<Q,U,M,SI,H>

org.djunits.vecmat.def.Matrix<Q,U,V,SI,H>

org.djunits.vecmat.def.Vector<Q,U,V,SI,H>

org.djunits.vecmat.dn.VectorN<Q,U,V,SI,H>

Type Parameters:

Q - the quantity type

U - the unit type

V - the vector type (Row or Col)

SI - the vector type with generics <SIQuantity, SIUnit<

H - the generic vector type with generics <?, ?< for Hadamard operations

All Implemented Interfaces:

Serializable, Iterable<Q>, Additive<V>, Scalable<V>, Value<U,V>, Hadamard<H,SI>, Normed<Q,U>

Direct Known Subclasses:

VectorN.Col, VectorN.Row

public abstract class VectorN<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>
extends Vector<Q,U,V,SI,H>

VectorN.java.

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorN.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>	VectorN.Col implements a column vector with real-valued entries.
static class	VectorN.Row<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>	VectorN.Row implements a row vector with real-valued entries.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DataGridSi<?>	dataSi	The data of the matrix, in SI unit.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VectorN(DataGridSi<?> dataSi, U displayUnit)	Create a new VectorN with a unit, based on a DataGridSi storage object that contains SI data.

Method Summary

Modifier and Type	Method	Description
int	cols()	Return the number of columns.
boolean	equals(Object obj)
Q[]	getScalarArray()	Return the vector as an array of scalars.
int	hashCode()
Iterator<Q>	iterator()	Create and return an iterator over the scalars in this vector in proper sequence.
Q	normL1()	Return the L1-norm of this element, expressed as a quantity.
Q	normL2()	Return the L2-norm of this element, expressed as a quantity.
Q	normLinf()	Return the L∞-norm of this element, expressed as a quantity.
Q	normLp(int p)	Return the Lp-norm of this element, expressed as a quantity.
int	rows()	Return the number of rows.
double[]	si()	Return a row-major array of SI-values for this matrix or vector.
double	si(int row, int col)	Return the si-value at position (row, col), where both row and col are 0-based values.
String	toString()	Return a concise description of this value.
String	toString(U withUnit)	Return a concise description of this value with the values expressed in the specified unit.

Methods inherited from class org.djunits.vecmat.def.Vector

get, isColumnVector, mget, msi, si, size

Methods inherited from class org.djunits.vecmat.def.Matrix

checkMultiply, checkMultiply, multiply

Methods inherited from class org.djunits.vecmat.def.VectorMatrix

abs, add, add, asMatrixNxM, asQuantityTable, checkCol, checkRow, divideElements, divideElements, get, getColumnScalars, getColumnSi, getColumnVector, getDisplayUnit, getRowScalars, getRowSi, getRowVector, getScalarGrid, instantiateSi, instantiateSi, invertElements, isRelative, max, mcheckCol, mcheckRow, mean, median, mget, mgetColumnScalars, mgetColumnSi, mgetColumnVector, mgetRowScalars, mgetRowSi, mgetRowVector, min, mode, msi, multiplyElements, multiplyElements, multiplyElements, negate, scaleBy, setDisplayUnit, subtract, subtract, sum

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.vecmat.operations.Hadamard

divideElements

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.djunits.vecmat.operations.Normed

norm

Methods inherited from interface org.djunits.value.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute, setDisplayUnit

Field Details

dataSi

protected final DataGridSi<?> dataSi

The data of the matrix, in SI unit.

Constructor Details

VectorN

protected VectorN(DataGridSi<?> dataSi,
 U displayUnit)

Create a new VectorN with a unit, based on a DataGridSi storage object that contains SI data.

Parameters:

dataSi - the data of the vector, in SI unit.

displayUnit - the display unit to use

Throws:

IllegalArgumentException - when the number of rows or columns does not have a positive value

Method Details

iterator

public Iterator<Q> iterator()

Description copied from class: Vector

Create and return an iterator over the scalars in this vector in proper sequence.

Specified by:

iterator in interface Iterable<Q extends Quantity<Q,U>>

Specified by:

iterator in class Vector<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Returns:

an iterator over the scalars in this vector in proper sequence

getScalarArray

public Q[] getScalarArray()

Description copied from class: Vector

Return the vector as an array of scalars.

Specified by:

getScalarArray in class Vector<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Returns:

the vector as an array of scalars

normL1

public Q normL1()

Description copied from interface: Normed

Return the L1-norm of this element, expressed as a quantity. The L1-norm is |x1| + |x2| + ... + |xn|.

Returns:

the L1-norm of this element, expressed as a quantity

normL2

public Q normL2()

Description copied from interface: Normed

Return the L2-norm of this element, expressed as a quantity. The L2-norm is sqrt(x1^2 + x2^2 + ... + xn^2).

Returns:

the L2-norm of this element, expressed as a quantity

normLp

public Q normLp(int p)

Description copied from interface: Normed

Return the Lp-norm of this element, expressed as a quantity. The Ln-norm is (x1^p + x2^p + ... + xn^p)^(1/p).

Parameters:

p - the rank of the norm

Returns:

the Lp-norm of this element, expressed as a quantity

normLinf

public Q normLinf()

Description copied from interface: Normed

Return the L∞-norm of this element, expressed as a quantity. The L∞-norm is max(|x1|, |x2|, ..., |xn|).

Returns:

the L∞-norm of this element, expressed as a quantity

rows

public int rows()

Description copied from class: VectorMatrix

Return the number of rows.

Specified by:

rows in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Returns:

the number of rows

cols

public int cols()

Description copied from class: VectorMatrix

Return the number of columns.

Specified by:

cols in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Returns:

the number of columns

si

public double[] si()

Description copied from class: VectorMatrix

Return a row-major array of SI-values for this matrix or vector. Note that this is NOT a safe copy.

Specified by:

si in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Returns:

the row-major array of SI-values

si

public double si(int row,
 int col)
          throws IndexOutOfBoundsException

Description copied from class: VectorMatrix

Return the si-value at position (row, col), where both row and col are 0-based values.

Specified by:

si in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Parameters:

row - the row (0-based)

col - the column (0-based)

Returns:

the si-value at position (row, col)

Throws:

IndexOutOfBoundsException - when row or col < 0 or larger than number of rows/columns - 1.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString(U withUnit)

Description copied from interface: Value

Return a concise description of this value with the values expressed in the specified unit.

Specified by:

toString in interface Value<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Overrides:

toString in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Parameters:

withUnit - the unit into which the values are converted for display

Returns:

a String with the value contents expressed in the specified unit

toString

public String toString()

Description copied from interface: Value

Return a concise description of this value.

Specified by:

toString in interface Value<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Overrides:

toString in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,V extends VectorN<Q,U,V,SI,H>,SI extends VectorN<SIQuantity,SIUnit,SI,?,?>,H extends VectorN<?,?,?,?,?>>

Returns:

a String with the value contents, without the type, with the unit attached.