Package org.djunits.vecmat.d3

Class Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

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.d3.Vector3<Q,U,Vector3.Col<Q,U>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

org.djunits.vecmat.d3.Vector3.Col<Q,U>

Type Parameters:

Q - the quantity type

U - the unit type

All Implemented Interfaces:

Serializable, Iterable<Q>, Additive<Vector3.Col<Q,U>>, Scalable<Vector3.Col<Q,U>>, Value<U,Vector3.Col<Q,U>>, Hadamard<Vector3.Col<?,?>,Vector3.Col<SIQuantity,SIUnit>>, Normed<Q,U>, VectorTransposable<Vector3.Row<Q,U>>

Enclosing class:

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

public static class Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>
extends Vector3<Q,U,Vector3.Col<Q,U>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>
implements VectorTransposable<Vector3.Row<Q,U>>

Vector3.Col implements a column vector with three real-valued entries. The vector is immutable, except for the display unit, which can be changed.

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/interfaces inherited from class org.djunits.vecmat.d3.Vector3

Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>, Vector3.Row<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Constructor Summary

Constructors

Constructor	Description
Col(double xInUnit, double yInUnit, double zInUnit, U displayUnit)	Create a new 3 column vector with a unit.

Method Summary

Modifier and Type	Method	Description
<TQ extends Quantity<TQ, TU>, TU extends UnitInterface<TU, TQ>> Vector3.Col<TQ,TU>	as(TU targetUnit)	Return the vector 'as' a vector with a known quantity, using a unit to express the result in.
int	cols()	Return the number of columns.
Vector3.Col<SIQuantity,SIUnit>	divideElements(Vector3.Col<?,?> other)	Divide the elements of this vector, matrix or table on an element-by-element basis with those of another collection of the same type (but possibly representing another quantity).
double[]	getColumnSi(int col)	Return an array with SI-values for the given column (0-based) from the vector or matrix.
Vector3.Col<Q,U>	getColumnVector(int col)	Return a quantity column (0-based) from the vector or matrix.
double[]	getRowSi(int row)	Return an array with SI-values for the given row (0-based) from the vector or matrix.
Vector1<Q,U>	getRowVector(int row)	Return a quantity row (0-based) from the vector or matrix.
Vector3.Col<SIQuantity,SIUnit>	instantiateSi(double[] siNew, SIUnit siUnit)	Return a new vector or matrix in SI-units with the given SI or BASE values.
protected Vector3.Col<Q,U>	instantiateSi(double xSi, double ySi, double zSi)	Return a new column or row vector with adapted x, y and z values.
Vector3.Col<SIQuantity,SIUnit>	invertElements()	Invert the vector, matrix or table on an element-by-element basis.
boolean	isColumnVector()	Return whether this vector is a column vector.
Vector3.Col<Q,U>	mgetColumnVector(int mCol)	Return a quantity column (1-based) from the vector or matrix.
Vector1<Q,U>	mgetRowVector(int mRow)	Return a quantity row (1-based) from the vector or matrix.
Matrix3x3<SIQuantity,SIUnit>	multiply(Vector3.Row<?,?> otherVec)	Multiply this column vector with a row vector, resulting in a square matrix.
Vector3.Col<SIQuantity,SIUnit>	multiplyElements(Quantity<?,?> quantity)	Multiply the elements of this vector, matrix or table by the given quantity.
Vector3.Col<SIQuantity,SIUnit>	multiplyElements(Vector3.Col<?,?> other)	Multiply the elements of this vector, matrix or table on an element-by-element basis with those of another collection of the same type (but possibly representing another quantity).
static <Q extends Quantity<Q, U>, U extends UnitInterface<U, Q>> Vector3.Col<Q,U>	of(double xInUnit, double yInUnit, double zInUnit, U displayUnit)	Create a Vector3 column vector without needing generics.
int	rows()	Return the number of rows.
double	si(int row, int col)	Return the si-value at position (row, col), where both row and col are 0-based values.
Vector3.Row<Q,U>	transpose()	Transpose the vector (swap rows and columns).

Methods inherited from class org.djunits.vecmat.d3.Vector3

abs, add, add, equals, getScalarArray, hashCode, instantiateSi, isRelative, iterator, max, mean, median, min, mode, negate, normL1, normL2, normLinf, normLp, scaleBy, si, si, size, subtract, subtract, sum, toString, toString, x, xSi, y, ySi, z, zSi

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

get, mget, msi

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

checkMultiply, checkMultiply, multiply

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

asMatrixNxM, asQuantityTable, checkCol, checkRow, divideElements, get, getColumnScalars, getDisplayUnit, getRowScalars, getScalarGrid, mcheckCol, mcheckRow, mget, mgetColumnScalars, mgetColumnSi, mgetRowScalars, mgetRowSi, msi, multiplyElements, setDisplayUnit

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

Constructor Details

Col

public Col(double xInUnit,
 double yInUnit,
 double zInUnit,
 U displayUnit)

Create a new 3 column vector with a unit.

Parameters:

xInUnit - the x-value expressed in the display unit

yInUnit - the y-value expressed in the display unit

zInUnit - the z-value expressed in the display unit

displayUnit - the display unit to use

Method Details

of

public static <Q extends Quantity<Q,
U>,
U extends UnitInterface<U,
Q>>
Vector3.Col<Q,U> of(double xInUnit,
 double yInUnit,
 double zInUnit,
 U displayUnit)

Create a Vector3 column vector without needing generics.

Type Parameters:

Q - the quantity type

U - the unit type

Parameters:

xInUnit - the x-value expressed in the display unit

yInUnit - the y-value expressed in the display unit

zInUnit - the z-value expressed in the display unit

displayUnit - the display unit to use

Returns:

a new Vector3 with a unit

isColumnVector

public boolean isColumnVector()

Description copied from class: Vector3

Return whether this vector is a column vector.

Specified by:

isColumnVector in class Vector3<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Returns:

whether this vector is a column vector

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>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

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>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Returns:

the number of columns

instantiateSi

protected Vector3.Col<Q,U> instantiateSi(double xSi,
 double ySi,
 double zSi)

Description copied from class: Vector3

Return a new column or row vector with adapted x, y and z values.

Specified by:

instantiateSi in class Vector3<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

xSi - the x value to use

ySi - the y value to use

zSi - the z value to use

Returns:

a new column or row vector with adapted x, y and z values

instantiateSi

public Vector3.Col<SIQuantity,SIUnit> instantiateSi(double[] siNew,
 SIUnit siUnit)

Description copied from class: VectorMatrix

Return a new vector or matrix in SI-units with the given SI or BASE values.

Specified by:

instantiateSi in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

siNew - the values for the new vector or matrix in row-major format

siUnit - the new unit for the new vector or matrix

Returns:

a new matrix with the provided SI or BASE 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>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

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.

getRowVector

public Vector1<Q,U> getRowVector(int row)

Description copied from class: VectorMatrix

Return a quantity row (0-based) from the vector or matrix. Note that the specific vector to return can be tightened by the implementing class.

Specified by:

getRowVector in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

row - the row number to retrieve (0-based)

Returns:

a row vector with the data at the given row

mgetRowVector

public Vector1<Q,U> mgetRowVector(int mRow)

Description copied from class: VectorMatrix

Return a quantity row (1-based) from the vector or matrix. Note that the specific vector to return can be tightened by the implementing class.

Specified by:

mgetRowVector in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

mRow - the row number to retrieve (1-based)

Returns:

a row vector with the data at the given row

getColumnVector

public Vector3.Col<Q,U> getColumnVector(int col)

Description copied from class: VectorMatrix

Return a quantity column (0-based) from the vector or matrix. Note that the specific vector to return can be tightened by the implementing class.

Specified by:

getColumnVector in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

col - the column number to retrieve (0-based)

Returns:

a column vector with the data at the given column

mgetColumnVector

public Vector3.Col<Q,U> mgetColumnVector(int mCol)

Description copied from class: VectorMatrix

Return a quantity column (1-based) from the vector or matrix. Note that the specific vector to return can be tightened by the implementing class.

Specified by:

mgetColumnVector in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

mCol - the column number to retrieve (1-based)

Returns:

a column vector with the data at the given column

getRowSi

public double[] getRowSi(int row)

Description copied from class: VectorMatrix

Return an array with SI-values for the given row (0-based) from the vector or matrix.

Specified by:

getRowSi in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

row - the row number to retrieve (0-based)

Returns:

an array with SI-values with the data at the given row

getColumnSi

public double[] getColumnSi(int col)

Description copied from class: VectorMatrix

Return an array with SI-values for the given column (0-based) from the vector or matrix.

Specified by:

getColumnSi in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

col - the column number to retrieve (0-based)

Returns:

an array with SI-values with the data at the given column

transpose

public Vector3.Row<Q,U> transpose()

Description copied from interface: VectorTransposable

Transpose the vector (swap rows and columns).

Specified by:

transpose in interface VectorTransposable<Q extends Quantity<Q,U>>

Returns:

the transposed vector

invertElements

public Vector3.Col<SIQuantity,SIUnit> invertElements()

Description copied from interface: Hadamard

Invert the vector, matrix or table on an element-by-element basis.

Specified by:

invertElements in interface Hadamard<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Overrides:

invertElements in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Returns:

a vector, matrix or table with an element-by-element inversion (1/value) of the elements

multiplyElements

public Vector3.Col<SIQuantity,SIUnit> multiplyElements(Vector3.Col<?,?> other)

Description copied from interface: Hadamard

Multiply the elements of this vector, matrix or table on an element-by-element basis with those of another collection of the same type (but possibly representing another quantity).

Specified by:

multiplyElements in interface Hadamard<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Overrides:

multiplyElements in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

other - the other collection of the same type

Returns:

a vector, matrix or table with an element-by-element multiplication of its elements

divideElements

public Vector3.Col<SIQuantity,SIUnit> divideElements(Vector3.Col<?,?> other)

Description copied from interface: Hadamard

Divide the elements of this vector, matrix or table on an element-by-element basis with those of another collection of the same type (but possibly representing another quantity).

Specified by:

divideElements in interface Hadamard<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Overrides:

divideElements in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

other - the other collection of the same type

Returns:

a vector, matrix or table with an element-by-element division of this collection's elements and other's elements

multiply

public Matrix3x3<SIQuantity,SIUnit> multiply(Vector3.Row<?,?> otherVec)

Multiply this column vector with a row vector, resulting in a square matrix.

Parameters:

otherVec - the row vector to multiply with

Returns:

the resulting matrix from the multiplication

multiplyElements

public Vector3.Col<SIQuantity,SIUnit> multiplyElements(Quantity<?,?> quantity)

Description copied from interface: Hadamard

Multiply the elements of this vector, matrix or table by the given quantity.

Specified by:

multiplyElements in interface Hadamard<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>

Overrides:

multiplyElements in class VectorMatrix<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>,Vector3.Col<Q extends Quantity<Q,U>,U extends UnitInterface<U,Q>>,Vector3.Col<SIQuantity,SIUnit>,Vector3.Col<?,?>>

Parameters:

quantity - the scalar quantity to multiply by

Returns:

a vector, matrix or table where the elements have been multiplied by the given quantity

as

public <TQ extends Quantity<TQ,
TU>,
TU extends UnitInterface<TU,
TQ>>
Vector3.Col<TQ,TU> as(TU targetUnit)
               throws IllegalArgumentException

Return the vector 'as' a vector with a known quantity, using a unit to express the result in. Throw a Runtime exception when the SI units of this vector and the target vector do not match.

Type Parameters:

TQ - target quantity type

TU - target unit type

Parameters:

targetUnit - the unit to convert the vector to

Returns:

a quantity typed in the target vector class

Throws:

IllegalArgumentException - when the units do not match