Struct OwnedMatrix 

pub struct OwnedMatrix<T, A: Allocator = Global> { /* private fields */ }

A matrix that owns its elements.

To pass it to algorithms, use the .data() and .data_mut() functions.

Example

#![feature(allocator_api)]
let mut A = OwnedMatrix::identity(2, 2, StaticRing::<i32>::RING);
let mut B = OwnedMatrix::identity(2, 2, StaticRing::<i32>::RING);
let mut C = OwnedMatrix::identity(2, 2, StaticRing::<i32>::RING);
StaticRing::<i32>::RING.get_ring().solve_right(A.data_mut(), B.data_mut(), C.data_mut(), Global).assert_solved();

Implementations

impl<T> OwnedMatrix<T>

pub fn from_fn<F>(row_count: usize, col_count: usize, f: F) -> Self

where F: FnMut(usize, usize) -> T,

Creates the row_count x col_count OwnedMatrix whose (i, j)-th entry is the output of the given function on (i, j).

pub fn zero<R: RingStore>(row_count: usize, col_count: usize, ring: R) -> Self

where R::Type: RingBase<Element = T>,

Creates the row_count x col_count zero matrix over the given ring.

pub fn identity<R: RingStore>( row_count: usize, col_count: usize, ring: R, ) -> Self

where R::Type: RingBase<Element = T>,

Creates the row_count x col_count identity matrix over the given ring.

impl<T, A: Allocator> OwnedMatrix<T, A>

pub fn new(data: Vec<T, A>, col_count: usize) -> Self

Creates the row_count x col_count OwnedMatrix matrix, whose entries are taken from the given vector, interpreted as a row-major matrix. The number of rows is row_count = data.len() / col_count.

If col_count is zero, this will panic. If that can happen, consider using OwnedMatrix::new_with_shape().

pub fn new_with_shape( data: Vec<T, A>, row_count: usize, col_count: usize, ) -> Self

Creates the row_count x col_count OwnedMatrix matrix, whose entries are taken from the given vector, interpreted as a row-major matrix.

Example

let matrix = OwnedMatrix::new_with_shape(vec![1, 2, 3, 4, 5, 6], 3, 2);
assert_eq!(3, *matrix.at(1, 0));
assert_eq!(6, *matrix.at(2, 1));

pub fn from_fn_in<F>( row_count: usize, col_count: usize, f: F, allocator: A, ) -> Self

where F: FnMut(usize, usize) -> T,

Available on crate feature unstable-enable only.

Creates the row_count x col_count OwnedMatrix whose (i, j)-th entry is the output of the given function on (i, j).

Availability

This API is marked as unstable and is only available when the unstable-enable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn data<'a>(&'a self) -> Submatrix<'a, AsFirstElement<T>, T>

Returns a Submatrix view on the data of this matrix.

pub fn data_mut<'a>(&'a mut self) -> SubmatrixMut<'a, AsFirstElement<T>, T>

Returns a SubmatrixMut view on the data of this matrix.

pub fn at(&self, i: usize, j: usize) -> &T

Returns a reference to the (i, j)-th entry of this matrix.

pub fn at_mut(&mut self, i: usize, j: usize) -> &mut T

Returns a mutable reference to the (i, j)-th entry of this matrix.

pub fn row_count(&self) -> usize

Returns the number of rows of this matrix.

pub fn col_count(&self) -> usize

Returns the number of columns of this matrix.

pub fn zero_in<R: RingStore>( row_count: usize, col_count: usize, ring: R, allocator: A, ) -> Self

where R::Type: RingBase<Element = T>,

Available on crate feature unstable-enable only.

Creates the row_count x col_count zero matrix over the given ring.

Availability

This API is marked as unstable and is only available when the unstable-enable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn identity_in<R: RingStore>( row_count: usize, col_count: usize, ring: R, allocator: A, ) -> Self

where R::Type: RingBase<Element = T>,

Available on crate feature unstable-enable only.

Creates the row_count x col_count identity matrix over the given ring.

Availability

This API is marked as unstable and is only available when the unstable-enable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn clone_matrix<R: RingStore>(&self, ring: R) -> Self

where R::Type: RingBase<Element = T>, A: Clone,

Available on crate feature unstable-enable only.

Availability

This API is marked as unstable and is only available when the unstable-enable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn set_row_count<F>(&mut self, new_count: usize, new_entries: F)

where F: FnMut() -> T,

Available on crate feature unstable-enable only.

Availability

This API is marked as unstable and is only available when the unstable-enable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations

impl<T: Debug, A: Allocator> Debug for OwnedMatrix<T, A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> MatrixCompare<T> for OwnedMatrix<T>

fn col_count(&self) -> usize

Returns the number of columns of the matrix.

fn row_count(&self) -> usize

Returns the number of rows of the matrix.

fn at(&self, i: usize, j: usize) -> &T

Returns a reference to the element at the given position.