NextControl Linear Algebra/dev.nextftc.linalg/Vector

Vector

class Vector<N : Nat> : Matrix<N, N1> (source)

A dimensionally type-safe column vector of doubles.

The dimension N is encoded at the type level using Nat types, allowing the compiler to catch dimension mismatches at compile time.

Example:

val a: SizedVector<N3> = SizedVector.of(N3, 1.0, 2.0, 3.0)
val b: SizedVector<N3> = SizedVector.of(N3, 4.0, 5.0, 6.0)
val c: SizedVector<N3> = a + b  // Compiles!
val dot: Double = a dot b
// val d: SizedVector<N2> = a + SizedVector.zero(N2)  // Won't compile - dimensions don't match

Type Parameters

N

The dimension type

Constructors

constructor(matrix: Matrix<N, N1>)

Types

object Companion

Properties

val dimension: Int

The dimension (length) of this vector.

@get:JvmName(name = "inverse")

val inverse: Matrix<N, N1>

The inverse of this matrix. Only valid for square matrices.

@get:JvmName(name = "magnitude")

val magnitude: Double

Returns the Euclidean norm (magnitude) of this vector.

val natColumns: N1

Natural number representing the number of columns.

Natural number representing the number of rows.

@get:JvmName(name = "norm")

val norm: Double

The Frobenius norm of this matrix.

val numColumns: Int

The number of columns in the matrix.

val numRows: Int

The number of rows in the matrix.

@get:JvmName(name = "pseudoInverse")

val pseudoInverse: Matrix<N1, N>

The pseudo-inverse of this matrix.

val size: Pair<Int, Int>

The size of the matrix as (rows, columns).

@get:JvmName(name = "transpose")

val transpose: Matrix<N1, N>

The transpose of this matrix, with swapped dimension types.

Functions

open override fun copy(): Vector<N>

Returns a copy of this vector.

open operator fun div(scalar: Double): Matrix<N, N1>

open operator fun div(scalar: Number): Matrix<N, N1>

Divides this matrix by a scalar.

infix fun dot(other: Vector<N>): Double

Computes the dot product of this vector with another vector of the same dimension.

open operator override fun equals(other: Any?): Boolean

fun <N : Nat> Matrix<N, N>.exp(): Matrix<N, N>

Computes the matrix exponential of this matrix, using the Padé approximant.

operator fun get(i: Int, j: Int): Double

Returns the element at the given indices.

operator fun get(i: Int): Double

Returns the element at the given index.

open override fun hashCode(): Int

operator fun minus(other: Matrix<N, N1>): Matrix<N, N1>

Subtracts another matrix with the same dimensions.

operator fun minus(other: Vector<N>): Vector<N>

Subtracts another vector with the same dimension.

fun normalized(): Vector<N>

Returns a normalized (unit) vector in the same direction.

operator fun plus(other: Matrix<N, N1>): Matrix<N, N1>

Adds another matrix with the same dimensions.

operator fun plus(other: Vector<N>): Vector<N>

Adds another vector with the same dimension.

operator fun set(i: Int, j: Int, value: Double)

Sets the element at the given indices.

operator fun set(i: Int, value: Double)

Sets the element at the given index.

fun <K : Nat> solve(other: Matrix<N, K>): Matrix<N1, K>

Solves for X in the equation AX = B, where A is this matrix and B is other.

operator fun <K : Nat> times(other: Matrix<N1, K>): Matrix<N, K>

Multiplies this matrix by another matrix. The inner dimensions must match: (R x C) * (C x K) = (R x K)

operator fun times(other: Vector<N1>): Vector<N>

Multiplies this matrix by a vector. The vector's length must be equal to C.

open operator override fun times(scalar: Double): Vector<N>

open operator override fun times(scalar: Number): Vector<N>

Multiplies this vector by a scalar.

toDynamicMatrix

fun toDynamicMatrix(): DynamicMatrix

Converts to a DynamicMatrix.

toDynamicVector

fun toDynamicVector(): DynamicVector

Converts to a DynamicVector.

open override fun toString(): String

open operator override fun unaryMinus(): Vector<N>

Negates all elements of this vector.