Package org.djunits.vecmat.d1

Class Vector1<Q extends Quantity<Q>>

java.lang.Object

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

org.djunits.vecmat.def.Vector<Q,Vector1<Q>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q>>

org.djunits.vecmat.d1.Vector1<Q>

Type Parameters:

Q - the quantity type

All Implemented Interfaces:

Serializable, Iterable<Q>, Additive<Vector1<Q>>, Scalable<Vector1<Q>>, Value<Vector1<Q>,Q>, Vector.Row<Vector1<Q>,Q>, Hadamard<Vector1<?>,Vector1<SIQuantity>>, Normed<Q>

public class Vector1<Q extends Quantity<Q>>
extends Vector<Q,Vector1<Q>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q>>
implements Vector.Row<Vector1<Q>,Q>

Vector1 implements a vector with one real-valued entry. The vector is immutable, except for the display unit, which can be changed. Some of the method that have been defined already for a generic vector have been re-implemented for efficiency.

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.def.Vector

Vector.Col<V extends Value<V,Q>,Q extends Quantity<Q>>, Vector.Row<V extends Value<V,Q>,Q extends Quantity<Q>>

Constructor Summary

Constructors

Constructor	Description
Vector1(double xSi, Unit<?,Q> displayUnit)	Create a new Vector1 with a display unit.

Method Summary

Modifier and Type	Method	Description
Vector1<Q>	abs()	Make the SI-values of this element absolute.
Vector1<Q>	add(Vector1<Q> other)	Add an element to this element, based on the SI-values.
Vector1<Q>	add(Q increment)	Return the a vector or matrix with entries that contain the sum of the element and the increment.
<TQ extends Quantity<TQ>> Vector1<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.
boolean	equals(Object obj)
Q[]	getScalarArray()	Return the vector as an array of scalars.
double[]	getSiArray()	Return a row-major array of SI-values for this matrix or vector.
int	hashCode()
Vector1<Q>	instantiateSi(double xSiNew)	Return a 1-vector with x value in SI or BASE units.
Vector1<Q>	instantiateSi(double[] siNew)	Return a new vector or matrix with the given SI or BASE values.
Vector1<SIQuantity>	instantiateSi(double[] siNew, SIUnit siUnit)	Return a new vector or matrix in SI-units with the given SI or BASE values.
boolean	isColumnVector()	Return whether this vector is a column vector.
boolean	isRelative()	Indicate whether this is a Relative Value.
boolean	isRowVector()	Return whether this vector is a row vector.
Iterator<Q>	iterator()	Create and return an iterator over the scalars in this vector in proper sequence.
Q	max()	Return the maximum value of the entries of the vector or matrix.
Q	mean()	Return the mean value of the entries of the vector or matrix.
Q	median()	Return the median value of the entries of the vector or matrix.
Q	min()	Return the minimum value of the entries of the vector or matrix.
Vector1<Q>	negate()	Negate this element, based on the SI-values.
int	nonZeroCount()	Return the number of non-zero entries in the vector, matrix or table.
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.
static <Q extends Quantity<Q>> Vector1<Q>	of(double[] dataInUnit, Unit<?,Q> unit)	Create a Vector1 without needing generics.
static <Q extends Quantity<Q>> Vector1<Q>	of(double xInUnit, Unit<?,Q> unit)	Create a Vector1 without needing generics.
static <Q extends Quantity<Q>> Vector1<Q>	of(Q x)	Create a Vector1 without needing generics.
static <Q extends Quantity<Q>> Vector1<Q>	of(Q[] data)	Create a Vector1 without needing generics.
static <Q extends Quantity<Q>> Vector1<Q>	ofSi(double[] dataSi, Unit<?,Q> displayUnit)	Create a Vector1 without needing generics.
static <Q extends Quantity<Q>> Vector1<Q>	ofSi(double xSi, Unit<?,Q> displayUnit)	Create a Vector1 without needing generics.
int	rows()	Return the number of rows.
Vector1<Q>	scaleBy(double factor)	Scale the element by a dimensionless factor, based on the SI-values.
double	si(int index)	Retrieve an si-value from the vector.
int	size()	Retrieve the size of the vector.
Vector1<Q>	subtract(Vector1<Q> other)	Subtract an element from this element, based on the SI-values.
Vector1<Q>	subtract(Q decrement)	Return the a vector or matrix with entries that contain the value minus the decrement.
Q	sum()	Return the sum of the values of the entries of the vector or matrix.
Vector1<Q>	transpose()	Return a transposed vector or matrix, where rows and columns have been swapped.
double[]	unsafeSiArray()	Return a row-major possibly UNSAFE array of SI-values for this matrix or vector.
Q	x()	Return the x-value of the vector as a quantity with the correct unit.
double	xSi()	Return the x-value of the vector in SI or BASE units.

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

get, 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, divideEntries, getDisplayUnit, invertEntries, multiplyElements, multiplyEntries, multiplyEntries, 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, setDisplayUnit, setDisplayUnit

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

format, format, format

Constructor Details

Vector1

public Vector1(double xSi,
 Unit<?,Q> displayUnit)

Create a new Vector1 with a display unit.

Parameters:

xSi - the x-value expressed in the SI unit for the quantity

displayUnit - the display unit of the vector

Method Details

instantiateSi

public Vector1<Q> instantiateSi(double xSiNew)

Return a 1-vector with x value in SI or BASE units.

Parameters:

xSiNew - the x value in SI or BASE units

Returns:

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

instantiateSi

public Vector1<Q> instantiateSi(double[] siNew)

Description copied from class: VectorMatrix

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

Specified by:

instantiateSi in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

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

Returns:

a new matrix with the provided SI or BASE values

size

public int size()

Description copied from class: Vector

Retrieve the size of the vector.

Specified by:

size in class Vector<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the size of the 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>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<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>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the number of columns

nonZeroCount

public int nonZeroCount()

Description copied from class: VectorMatrix

Return the number of non-zero entries in the vector, matrix or table. Note that NaN and Infinity count as a non-zero element. The value -0.0 counts as 0.0.

Specified by:

nonZeroCount in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the number of non-zero entries in the vector, matrix or table

transpose

public Vector1<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>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

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

instantiateSi

public Vector1<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>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<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

isColumnVector

public boolean isColumnVector()

Description copied from class: Vector

Return whether this vector is a column vector.

Specified by:

isColumnVector in class Vector<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

whether this vector is a column vector

isRowVector

public boolean isRowVector()

Description copied from class: Vector

Return whether this vector is a row vector.

Overrides:

isRowVector in class Vector<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

whether this vector is a row vector

si

public double si(int index)
          throws IndexOutOfBoundsException

Description copied from class: Vector

Retrieve an si-value from the vector.

Specified by:

si in class Vector<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

index - the index (0-based) to retrieve the value from

Returns:

the value as a Scalar

Throws:

IndexOutOfBoundsException - in case index is out of bounds

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>>

Specified by:

iterator in class Vector<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

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>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the vector as an array of scalars

xSi

public double xSi()

Return the x-value of the vector in SI or BASE units.

Returns:

the x-value of the vector in SI or BASE units

unsafeSiArray

public double[] unsafeSiArray()

Description copied from class: VectorMatrix

Return a row-major possibly UNSAFE array of SI-values for this matrix or vector. The method might give access to the underlying data structure, so treat the data carefully.

Specified by:

unsafeSiArray in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the row-major array of SI-values (safe copy)

getSiArray

public double[] getSiArray()

Description copied from class: VectorMatrix

Return a row-major array of SI-values for this matrix or vector. This is guaranteed to be a safe copy.

Specified by:

getSiArray in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the row-major array of SI-values (safe copy)

x

public Q x()

Return the x-value of the vector as a quantity with the correct unit.

Returns:

the x-value of the vector as a quantity with the correct unit

scaleBy

public Vector1<Q> scaleBy(double factor)

Description copied from interface: Scalable

Scale the element by a dimensionless factor, based on the SI-values. Note that this can lead to unwanted effects for elements with Offset scales. 2 * 10 °C = 293.15 °C and not 20 °C.

Specified by:

scaleBy in interface Scalable<Q extends Quantity<Q>>

Overrides:

scaleBy in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

factor - the dimensionless scale factor

Returns:

a new element with all of its SI-values scaled by the dimensionless factor

add

public Vector1<Q> add(Vector1<Q> other)

Description copied from interface: Additive

Add an element to this element, based on the SI-values. Note that this can lead to unwanted effects for elements with Offset scales: 10 °C + 5 °C = 288.15 °C and not 15 °C.

Specified by:

add in interface Additive<Q extends Quantity<Q>>

Overrides:

add in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

other - the element to add to this element

Returns:

the sum of the SI-values of this element and the SI-values of the other element

subtract

public Vector1<Q> subtract(Vector1<Q> other)

Description copied from interface: Additive

Subtract an element from this element, based on the SI-values.

Specified by:

subtract in interface Additive<Q extends Quantity<Q>>

Overrides:

subtract in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

other - the element to subtract from this element

Returns:

a new element with the SI-values of this element minus the SI-values of the other element

negate

public Vector1<Q> negate()

Description copied from interface: Additive

Negate this element, based on the SI-values. Note that this can lead to unwanted effects for elements with Offset scales. A temperature in Celsius that is negated, will have its Kelvin temperatures negated.

Specified by:

negate in interface Additive<Q extends Quantity<Q>>

Overrides:

negate in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

a new element with all of its SI-values negated

abs

public Vector1<Q> abs()

Description copied from interface: Additive

Make the SI-values of this element absolute. A new element wil be returned. Note that this can lead to unwanted effects for elements with Offset scales. A temperature of -10 degrees Celsius will have its Kelvin temperatures negated.

Specified by:

abs in interface Additive<Q extends Quantity<Q>>

Overrides:

abs in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

a new element with the absolute value for all of its SI-values

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|.

Specified by:

normL1 in interface Normed<Q extends Quantity<Q>>

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).

Specified by:

normL2 in interface Normed<Q extends Quantity<Q>>

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).

Specified by:

normLp in interface Normed<Q extends Quantity<Q>>

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|).

Specified by:

normLinf in interface Normed<Q extends Quantity<Q>>

Returns:

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

mean

public Q mean()

Description copied from class: VectorMatrix

Return the mean value of the entries of the vector or matrix.

Overrides:

mean in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the mean value of the entries of the vector or matrix

min

public Q min()

Description copied from class: VectorMatrix

Return the minimum value of the entries of the vector or matrix.

Overrides:

min in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the minimum value of the entries of the vector or matrix

max

public Q max()

Description copied from class: VectorMatrix

Return the maximum value of the entries of the vector or matrix.

Overrides:

max in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the maximum value of the entries of the vector or matrix

median

public Q median()

Description copied from class: VectorMatrix

Return the median value of the entries of the vector or matrix.

Overrides:

median in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the median value of the entries of the vector or matrix

sum

public Q sum()

Description copied from class: VectorMatrix

Return the sum of the values of the entries of the vector or matrix.

Overrides:

sum in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

the sum of the values of the entries of the vector or matrix

add

public Vector1<Q> add(Q increment)

Description copied from class: VectorMatrix

Return the a vector or matrix with entries that contain the sum of the element and the increment.

Overrides:

add in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

increment - the quantity by which to increase the values of the vector or matrix

Returns:

a vector or matrix with entries that are incremented by the given quantity

subtract

public Vector1<Q> subtract(Q decrement)

Description copied from class: VectorMatrix

Return the a vector or matrix with entries that contain the value minus the decrement.

Overrides:

subtract in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Parameters:

decrement - the quantity by which to decrease the values of the vector or matrix

Returns:

a vector or matrix with entries that are decremented by the given quantity

isRelative

public boolean isRelative()

Description copied from interface: Value

Indicate whether this is a Relative Value.

Specified by:

isRelative in interface Value<Vector1<Q extends Quantity<Q>>,Q extends Quantity<Q>>

Overrides:

isRelative in class VectorMatrix<Q extends Quantity<Q>,Vector1<Q extends Quantity<Q>>,Vector1<SIQuantity>,Vector1<?>,Vector1<Q extends Quantity<Q>>>

Returns:

whether this is a Relative Value

of

public static <Q extends Quantity<Q>> Vector1<Q> of(double xInUnit,
 Unit<?,Q> unit)

Create a Vector1 without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

xInUnit - the x-value expressed in the unit

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

Returns:

a new Vector1 with a unit

of

public static <Q extends Quantity<Q>> Vector1<Q> of(Q x)

Create a Vector1 without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

x - the x-value expressed as a quantity

Returns:

a new Vector1 with a unit

of

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

Create a Vector1 without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

dataInUnit - the x-value 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 Vector1 with a unit

ofSi

public static <Q extends Quantity<Q>> Vector1<Q> ofSi(double xSi,
 Unit<?,Q> displayUnit)

Create a Vector1 without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

xSi - the x-value expressed in the SI unit

displayUnit - the display unit to use

Returns:

a new Vector1 with the display unit

ofSi

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

Create a Vector1 without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

dataSi - the x-value expressed as an array in the SI units

displayUnit - the display unit to use

Returns:

a new Vector1 with a unit

of

public static <Q extends Quantity<Q>> Vector1<Q> of(Q[] data)

Create a Vector1 without needing generics.

Type Parameters:

Q - the quantity type

Parameters:

data - the x-value expressed as an array of quantities

Returns:

a new Vector1 with a unit

as

public <TQ extends Quantity<TQ>> Vector1<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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object