Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

alexandria_linalg

Fully qualified path: alexandria_linalg

Modules

dot
kronKronecker product of two arrays
normNorm of an T array.

Modules

Modules

dot
kronKronecker product of two arrays
normNorm of an T array.

dot

Fully qualified path: alexandria_linalg::dot

Free functions

dotCompute the dot product for 2 given arrays….

Free functions

Free functions

dotCompute the dot product for 2 given arrays….

dot

Compute the dot product for 2 given arrays.

Arguments

  • xs - The first sequence of len L.
  • ys - The second sequence of len L.

Returns

  • sum - The dot product.

Fully qualified path: alexandria_linalg::dot::dot

pub fn dot<T, +Mul<T>, +AddAssign<T, T>, +Zero<T>, +Copy<T>, +Drop<T>>(
    mut xs: Span<T>, mut ys: Span<T>,
) -> T

kron

Kronecker product of two arrays

Fully qualified path: alexandria_linalg::kron

Free functions

kronCompute the Kronecker product for 2 given arrays….

Enums

Free functions

Free functions

kronCompute the Kronecker product for 2 given arrays….

kron

Compute the Kronecker product for 2 given arrays.

Arguments

  • xs - The first sequence of len L.
  • ys - The second sequence of len L.

Returns

  • Result<Array<T>, KronError> - The Kronecker product.

Fully qualified path: alexandria_linalg::kron::kron

pub fn kron<T, +Mul<T>, +Copy<T>, +Drop<T>>(
    mut xs: Span<T>, mut ys: Span<T>,
) -> Result<Array<T>, KronError>

Enums

Enums

KronError

Fully qualified path: alexandria_linalg::kron::KronError

pub enum KronError {
    UnequalLength,
}

Variants

UnequalLength

Fully qualified path: alexandria_linalg::kron::KronError::UnequalLength

UnequalLength

norm

Norm of an T array.

Fully qualified path: alexandria_linalg::norm

Free functions

normCompute the norm for an T array….

Free functions

Free functions

normCompute the norm for an T array….

norm

Compute the norm for an T array.

Arguments

  • array - The inputted array.
  • ord - The order of the norm.
  • iter - The number of iterations to run the algorithm

Returns

  • u128 - The norm for the array.

Fully qualified path: alexandria_linalg::norm::norm

pub fn norm<T, +Into<T, u128>, +Zero<T>, +Copy<T>, +Drop<T>>(
    mut xs: Span<T>, ord: u128, iter: u32,
) -> u128