Module matrix 

Contains the core of feanor-math’s (currently) minimalistic approach to matrices. In particular, we use matrix::Submatrix and matrix::SubmatrixMut for matrices that don’t own their data.

Modules

matrix_compare

Defines a very general way of comparing anything that can be interpreted as a matrix in matrix_compare::MatrixCompare. Used solely in crate::assert_matrix_eq, with tests being the primary use case.

transform

Contains the trait transform::TransformTarget, for “consumers” of elementary matrix operations.

Structs

AsFirstElement

Represents a contiguous batch of Ts by their first element. In other words, a pointer to the batch is equal to a pointer to the first value.

Column

An immutable view on a column of a matrix Submatrix.

ColumnMut

A mutable view on a column of a matrix SubmatrixMut.

ColumnMutIter

Iterator over mutable references to the entries of a column of a matrix SubmatrixMut.

DerefArray

Newtype for [T; SIZE] that implements Deref<Target = [T]> so that it can be used to store columns and access them through Submatrix.

OwnedMatrix

A matrix that owns its elements.

Submatrix

Immutable view on a matrix that stores elements of type T.

SubmatrixMut

Mutable view on a matrix that stores elements of type T.

SubmatrixRawunstable-enable

A submatrix that works on raw pointers, thus does not care about mutability and borrowing. It already takes care about bounds checking and indexing. Nevertheless, it is quite difficult to use this correctly, best not use it at all. I mainly made it public to allow doctests.

TransposableSubmatrixunstable-enable

Availability

TransposableSubmatrixMutunstable-enable

Availability

Traits

AsPointerToSlice

Trait for objects that can be considered a contiguous part of memory. In particular, the pointer returned by get_pointer() should be interpreted as the pointer to the first element of a range of elements of type T (basically a C-style array). In some sense, this is thus the unsafe equivalent of Deref<Target = [T]>.

Functions

format_matrixunstable-enable

Availability