Package org.djunits.vecmat.d3

Class Vector3.Col<Q extends Quantity<Q>>

java.lang.Object

org.djunits.vecmat.def.VectorMatrix<Q,V,SI,H,VT>

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

org.djunits.vecmat.d3.Vector3<Q,Vector3.Col<Q>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q>>

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

Type Parameters:

Q - the quantity type

All Implemented Interfaces:

Serializable, Iterable<Q>, Additive<Vector3.Col<Q>>, Scalable<Vector3.Col<Q>>, Value<Vector3.Col<Q>,Q>, Vector.Col<Vector3.Col<Q>,Q>, Hadamard<Vector3.Col<?>,Vector3.Col<SIQuantity>>, Normed<Q>

Enclosing class:

Vector3<Q extends Quantity<Q>,V extends Vector3<Q,V,SI,H,VT>,SI extends Vector3<SIQuantity,SI,?,?,?>,H extends Vector3<?,?,?,?,?>,VT extends Vector3<Q,VT,?,?,V>>

public static class Vector3.Col<Q extends Quantity<Q>>
extends Vector3<Q,Vector3.Col<Q>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q>>
implements Vector.Col<Vector3.Col<Q>,Q>

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>>, Vector3.Row<Q extends Quantity<Q>>

Constructor Summary

Constructors

Constructor	Description
Col(double xSi, double ySi, double zSi, Unit<?,Q> displayUnit)	Create a new 3 column vector with a display unit.

Method Summary

Modifier and Type	Method	Description
<TQ extends Quantity<TQ>> Vector3.Col<TQ>	as(Unit<?,TQ> 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>	divideEntries(Vector3.Col<?> other)	Divide the entries of this vector, matrix or table on an entry-by-entry basis with those of another collection of the same type (but possibly representing another quantity).
Vector3.Col<SIQuantity>	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>	instantiateSi(double xSi, double ySi, double zSi)	Return a new column or row vector with adapted x, y and z values.
Vector3.Col<SIQuantity>	invertEntries()	Invert the vector, matrix or table on an entry-by-entry basis.
boolean	isColumnVector()	Return whether this vector is a column vector.
Matrix3x3<SIQuantity>	multiply(Vector3.Row<?> otherVec)	Multiply this column vector with a row vector, resulting in a square matrix.
Vector3.Col<SIQuantity>	multiplyEntries(Quantity<?> quantity)	Multiply the entries of this vector, matrix or table by the given quantity.
Vector3.Col<SIQuantity>	multiplyEntries(Vector3.Col<?> other)	Multiply the entries of this vector, matrix or table on an entry-by-entry basis with those of another collection of the same type (but possibly representing another quantity).
static <Q extends Quantity<Q>> Vector3.Col<Q>	of(double[] dataInUnit, Unit<?,Q> unit)	Create a Vector3.Col without needing generics.
static <Q extends Quantity<Q>> Vector3.Col<Q>	of(double xInUnit, double yInUnit, double zInUnit, Unit<?,Q> unit)	Create a Vector3.Col without needing generics.
static <Q extends Quantity<Q>> Vector3.Col<Q>	of(Q[] data)	Create a Vector3.Col without needing generics.
static <Q extends Quantity<Q>> Vector3.Col<Q>	of(Q x, Q y, Q z)	Create a Vector3.Col without needing generics.
static <Q extends Quantity<Q>> Vector3.Col<Q>	ofSi(double[] dataSi, Unit<?,Q> displayUnit)	Create a Vector3.Col without needing generics.
static <Q extends Quantity<Q>> Vector3.Col<Q>	ofSi(double xSi, double ySi, double zSi, Unit<?,Q> displayUnit)	Create a Vector3.Col without needing generics.
int	rows()	Return the number of rows.
Vector3.Row<Q>	transpose()	Return a transposed vector or matrix, where rows and columns have been swapped.

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

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

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

get, isRowVector, mget, msi

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

asMatrix1x1, asMatrix2x2, asMatrix3x3, asMatrixNxM, asMatrixNxN, asQuantityTable, asVector1, asVector2Col, asVector2Row, asVector3Col, asVector3Row, asVectorNCol, asVectorNRow, checkMultiply, checkMultiply, divideElements, getDisplayUnit, multiplyElements, nnz, setDisplayUnit, toString

Methods inherited from class java.lang.Object

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

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

divideEntries

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

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, setDisplayUnit

Methods inherited from interface org.djunits.vecmat.def.Vector.Col

format, format, format

Constructor Details

Col

public Col(double xSi,
 double ySi,
 double zSi,
 Unit<?,Q> displayUnit)

Create a new 3 column vector with a display unit.

Parameters:

xSi - the x-value expressed in the SI unit

ySi - the y-value expressed in the SI unit

zSi - the z-value expressed in the SI unit

displayUnit - the display unit to use

Method Details

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

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

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

Returns:

the number of columns

instantiateSi

protected Vector3.Col<Q> 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>,Vector3.Col<Q extends Quantity<Q>>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q extends Quantity<Q>>>

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

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

transpose

public Vector3.Row<Q> transpose()

Description copied from class: VectorMatrix

Return a transposed vector or matrix, where rows and columns have been swapped.

Specified by:

transpose in class VectorMatrix<Q extends Quantity<Q>,Vector3.Col<Q extends Quantity<Q>>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q extends Quantity<Q>>>

Returns:

a transposed vector or matrix, where rows and columns have been swapped

invertEntries

public Vector3.Col<SIQuantity> invertEntries()

Description copied from interface: Hadamard

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

Specified by:

invertEntries in interface Hadamard<Vector3.Col<?>,Vector3.Col<SIQuantity>>

Overrides:

invertEntries in class VectorMatrix<Q extends Quantity<Q>,Vector3.Col<Q extends Quantity<Q>>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q extends Quantity<Q>>>

Returns:

a new vector, matrix or table with an entry-by-entry inversion (1/value) of the entries

multiplyEntries

public Vector3.Col<SIQuantity> multiplyEntries(Vector3.Col<?> other)

Description copied from interface: Hadamard

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

Specified by:

multiplyEntries in interface Hadamard<Vector3.Col<?>,Vector3.Col<SIQuantity>>

Overrides:

multiplyEntries in class VectorMatrix<Q extends Quantity<Q>,Vector3.Col<Q extends Quantity<Q>>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q extends Quantity<Q>>>

Parameters:

other - the other collection of the same type

Returns:

a new vector, matrix or table with an entry-by-entry multiplication of its entries

divideEntries

public Vector3.Col<SIQuantity> divideEntries(Vector3.Col<?> other)

Description copied from interface: Hadamard

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

Specified by:

divideEntries in interface Hadamard<Vector3.Col<?>,Vector3.Col<SIQuantity>>

Overrides:

divideEntries in class VectorMatrix<Q extends Quantity<Q>,Vector3.Col<Q extends Quantity<Q>>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q extends Quantity<Q>>>

Parameters:

other - the other collection of the same type

Returns:

a new vector, matrix or table with an entry-by-entry division of this collection's entries and other's entries

multiply

public Matrix3x3<SIQuantity> 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

multiplyEntries

public Vector3.Col<SIQuantity> multiplyEntries(Quantity<?> quantity)

Description copied from interface: Hadamard

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

Specified by:

multiplyEntries in interface Hadamard<Vector3.Col<?>,Vector3.Col<SIQuantity>>

Overrides:

multiplyEntries in class VectorMatrix<Q extends Quantity<Q>,Vector3.Col<Q extends Quantity<Q>>,Vector3.Col<SIQuantity>,Vector3.Col<?>,Vector3.Row<Q extends Quantity<Q>>>

Parameters:

quantity - the scalar quantity to multiply by

Returns:

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

of

public static <Q extends Quantity<Q>>
Vector3.Col<Q> of(double xInUnit,
 double yInUnit,
 double zInUnit,
 Unit<?,Q> unit)

Create a Vector3.Col without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

xInUnit - the x-value expressed in the unit

yInUnit - the y-value expressed in the unit

zInUnit - the z-value expressed in the unit

unit - the unit of the data, which will also be used as the display unit

Returns:

a new Vector3.Col with a unit

of

public static <Q extends Quantity<Q>>
Vector3.Col<Q> of(Q x,
 Q y,
 Q z)

Create a Vector3.Col without needing generics. The display unit will be taken from the x-quantity.

Type Parameters:

Q - the quantity type

Parameters:

x - the x-value expressed as a quantity

y - the y-value expressed as a quantity

z - the z-value expressed as a quantity

Returns:

a new Vector3.Col with a unit

of

public static <Q extends Quantity<Q>>
Vector3.Col<Q> of(double[] dataInUnit,
 Unit<?,Q> unit)

Create a Vector3.Col without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

dataInUnit - the vector entries expressed as an array in the display unit

unit - the unit of the data, which will also be used as the display unit

Returns:

a new Vector3.Col with a unit

ofSi

public static <Q extends Quantity<Q>>
Vector3.Col<Q> ofSi(double[] dataSi,
 Unit<?,Q> displayUnit)

Create a Vector3.Col without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

dataSi - the vector entries expressed as an array in the SI units

displayUnit - the display unit to use

Returns:

a new Vector3.Col with a unit

ofSi

public static <Q extends Quantity<Q>>
Vector3.Col<Q> ofSi(double xSi,
 double ySi,
 double zSi,
 Unit<?,Q> displayUnit)

Create a Vector3.Col without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

xSi - the x vector entry expressed in the SI unit

ySi - the y vector entry expressed in the SI unit

zSi - the z vector entry expressed in the SI unit

displayUnit - the display unit to use

Returns:

a new Vector3.Col with a unit

of

public static <Q extends Quantity<Q>>
Vector3.Col<Q> of(Q[] data)

Create a Vector3.Col without needing generics. The display unit will be taken from the first quantity in the array.

Type Parameters:

Q - the quantity type

Parameters:

data - the vector entries expressed as an array of quantities

Returns:

a new Vector3.Col with a unit

as

public <TQ extends Quantity<TQ>> Vector3.Col<TQ> as(Unit<?,TQ> 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

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