Struct matrix::format::conventional::Conventional

pub struct Conventional<T: Element> {
    pub rows: usize,
    pub columns: usize,
    pub values: Vec<T>,
}

A conventional matrix.

Fields

rows: usize

The number of rows.

columns: usize

The number of columns.

values: Vec<T>

The values stored in the column-major order.

Methods

impl<T: Element> Conventional<T>

fn new<S: Size>(size: S) -> Self

Create a zero matrix.

fn from_slice<S: Size>(size: S, values: &[T]) -> Self

Create a matrix from a slice.

fn from_vec<S: Size>(size: S, values: Vec<T>) -> Self

Create a matrix from a vector.

unsafe fn with_uninitialized<S: Size>(size: S) -> Self

Create a matrix with uninitialized elements.

unsafe fn erase(&mut self)

Zero out the content.

The function should only be used when it is safe to overwrite T with zero bytes.

fn resize<S: Size>(&mut self, size: S)

Resize.

Methods from Deref<Target=[T]>

fn len(&self) -> usize

Returns the number of elements in the slice.

Example

let a = [1, 2, 3];
assert_eq!(a.len(), 3);

fn is_empty(&self) -> bool

Returns true if the slice has a length of 0

Example

let a = [1, 2, 3];
assert!(!a.is_empty());

fn first(&self) -> Option<&T>

Returns the first element of a slice, or None if it is empty.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&10), v.first());

let w: &[i32] = &[];
assert_eq!(None, w.first());

fn first_mut(&mut self) -> Option<&mut T>

Returns a mutable pointer to the first element of a slice, or None if it is empty

fn split_first(&self) -> Option<(&T, &[T])>

Returns the first and all the rest of the elements of a slice.

fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])>

Returns the first and all the rest of the elements of a slice.

fn split_last(&self) -> Option<(&T, &[T])>

Returns the last and all the rest of the elements of a slice.

fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])>

Returns the last and all the rest of the elements of a slice.

fn last(&self) -> Option<&T>

Returns the last element of a slice, or None if it is empty.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&30), v.last());

let w: &[i32] = &[];
assert_eq!(None, w.last());

fn last_mut(&mut self) -> Option<&mut T>

Returns a mutable pointer to the last item in the slice.

fn get(&self, index: usize) -> Option<&T>

Returns the element of a slice at the given index, or None if the index is out of bounds.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&40), v.get(1));
assert_eq!(None, v.get(3));

fn get_mut(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to the element at the given index, or None if the index is out of bounds

unsafe fn get_unchecked(&self, index: usize) -> &T

Returns a pointer to the element at the given index, without doing bounds checking.

unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T

Returns an unsafe mutable pointer to the element in index

fn as_ptr(&self) -> *const T

Returns an raw pointer to the slice's buffer

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

fn as_mut_ptr(&mut self) -> *mut T

Returns an unsafe mutable pointer to the slice's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

fn swap(&mut self, a: usize, b: usize)

Swaps two elements in a slice.

Arguments

• a - The index of the first element
• b - The index of the second element

Panics

Panics if a or b are out of bounds.

Example

let mut v = ["a", "b", "c", "d"];
v.swap(1, 3);
assert!(v == ["a", "d", "c", "b"]);

fn reverse(&mut self)

Reverse the order of elements in a slice, in place.

Example

let mut v = [1, 2, 3];
v.reverse();
assert!(v == [3, 2, 1]);

fn iter(&self) -> Iter<T>

Returns an iterator over the slice.

fn iter_mut(&mut self) -> IterMut<T>

Returns an iterator that allows modifying each value

fn windows(&self, size: usize) -> Windows<T>

Returns an iterator over all contiguous windows of length size. The windows overlap. If the slice is shorter than size, the iterator returns no values.

Panics

Panics if size is 0.

Example

Print the adjacent pairs of a slice (i.e. [1,2], [2,3], [3,4]):

let v = &[1, 2, 3, 4];
for win in v.windows(2) {
    println!("{:?}", win);
}

fn chunks(&self, size: usize) -> Chunks<T>

Returns an iterator over size elements of the slice at a time. The chunks are slices and do not overlap. If size does not divide the length of the slice, then the last chunk will not have length size.

Panics

Panics if size is 0.

Example

Print the slice two elements at a time (i.e. [1,2], [3,4], [5]):

let v = &[1, 2, 3, 4, 5];
for chunk in v.chunks(2) {
    println!("{:?}", chunk);
}

fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<T>

Returns an iterator over chunk_size elements of the slice at a time. The chunks are mutable slices, and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

Panics

Panics if chunk_size is 0.

fn split_at(&self, mid: usize) -> (&[T], &[T])

Divides one slice into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

Examples

let v = [10, 40, 30, 20, 50];
let (v1, v2) = v.split_at(2);
assert_eq!([10, 40], v1);
assert_eq!([30, 20, 50], v2);

fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T])

Divides one &mut into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

Example

let mut v = [1, 2, 3, 4, 5, 6];

// scoped to restrict the lifetime of the borrows
{
   let (left, right) = v.split_at_mut(0);
   assert!(left == []);
   assert!(right == [1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_at_mut(2);
    assert!(left == [1, 2]);
    assert!(right == [3, 4, 5, 6]);
}

{
    let (left, right) = v.split_at_mut(6);
    assert!(left == [1, 2, 3, 4, 5, 6]);
    assert!(right == []);
}

fn split<F>(&self, pred: F) -> Split<T, F> where F: FnMut(&T) -> bool

Returns an iterator over subslices separated by elements that match pred. The matched element is not contained in the subslices.

Examples

Print the slice split by numbers divisible by 3 (i.e. [10, 40], [20], [50]):

let v = [10, 40, 30, 20, 60, 50];
for group in v.split(|num| *num % 3 == 0) {
    println!("{:?}", group);
}

fn split_mut<F>(&mut self, pred: F) -> SplitMut<T, F> where F: FnMut(&T) -> bool

Returns an iterator over mutable subslices separated by elements that match pred. The matched element is not contained in the subslices.

fn splitn<F>(&self, n: usize, pred: F) -> SplitN<T, F> where F: FnMut(&T) -> bool

Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

Print the slice split once by numbers divisible by 3 (i.e. [10, 40], [20, 60, 50]):

let v = [10, 40, 30, 20, 60, 50];
for group in v.splitn(2, |num| *num % 3 == 0) {
    println!("{:?}", group);
}

fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<T, F> where F: FnMut(&T) -> bool

Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<T, F> where F: FnMut(&T) -> bool

Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

Print the slice split once, starting from the end, by numbers divisible by 3 (i.e. [50], [10, 40, 30, 20]):

let v = [10, 40, 30, 20, 60, 50];
for group in v.rsplitn(2, |num| *num % 3 == 0) {
    println!("{:?}", group);
}

fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<T, F> where F: FnMut(&T) -> bool

Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

fn contains(&self, x: &T) -> bool where T: PartialEq<T>

Returns true if the slice contains an element with the given value.

Examples

let v = [10, 40, 30];
assert!(v.contains(&30));
assert!(!v.contains(&50));

fn starts_with(&self, needle: &[T]) -> bool where T: PartialEq<T>

Returns true if needle is a prefix of the slice.

Examples

let v = [10, 40, 30];
assert!(v.starts_with(&[10]));
assert!(v.starts_with(&[10, 40]));
assert!(!v.starts_with(&[50]));
assert!(!v.starts_with(&[10, 50]));

fn ends_with(&self, needle: &[T]) -> bool where T: PartialEq<T>

Returns true if needle is a suffix of the slice.

Examples

let v = [10, 40, 30];
assert!(v.ends_with(&[30]));
assert!(v.ends_with(&[40, 30]));
assert!(!v.ends_with(&[50]));
assert!(!v.ends_with(&[50, 30]));

fn binary_search(&self, x: &T) -> Result<usize, usize> where T: Ord

Binary search a sorted slice for a given element.

If the value is found then Ok is returned, containing the index of the matching element; if the value is not found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

Example

Looks up a series of four elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1,4].

let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

assert_eq!(s.binary_search(&13),  Ok(9));
assert_eq!(s.binary_search(&4),   Err(7));
assert_eq!(s.binary_search(&100), Err(13));
let r = s.binary_search(&1);
assert!(match r { Ok(1...4) => true, _ => false, });

fn binary_search_by<F>(&self, f: F) -> Result<usize, usize> where F: FnMut(&T) -> Ordering

Binary search a sorted slice with a comparator function.

The comparator function should implement an order consistent with the sort order of the underlying slice, returning an order code that indicates whether its argument is Less, Equal or Greater the desired target.

If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

Example

Looks up a series of four elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1,4].

let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

let seek = 13;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9));
let seek = 4;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7));
let seek = 100;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13));
let seek = 1;
let r = s.binary_search_by(|probe| probe.cmp(&seek));
assert!(match r { Ok(1...4) => true, _ => false, });

fn binary_search_by_key<B, F>(&self, b: &B, f: F) -> Result<usize, usize> where B: Ord, F: FnMut(&T) -> B

Binary search a sorted slice with a key extraction function.

Assumes that the slice is sorted by the key, for instance with sort_by_key using the same key extraction function.

If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

Examples

Looks up a series of four elements in a slice of pairs sorted by their second elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1,4].

let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1),
         (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
         (1, 21), (2, 34), (4, 55)];

assert_eq!(s.binary_search_by_key(&13, |&(a,b)| b),  Ok(9));
assert_eq!(s.binary_search_by_key(&4, |&(a,b)| b),   Err(7));
assert_eq!(s.binary_search_by_key(&100, |&(a,b)| b), Err(13));
let r = s.binary_search_by_key(&1, |&(a,b)| b);
assert!(match r { Ok(1...4) => true, _ => false, });

fn sort(&mut self) where T: Ord

This is equivalent to self.sort_by(|a, b| a.cmp(b)).

This sort is stable and O(n log n) worst-case but allocates approximately 2 * n where n is the length of self.

Examples

let mut v = [-5, 4, 1, -3, 2];

v.sort();
assert!(v == [-5, -3, 1, 2, 4]);

fn sort_by_key<B, F>(&mut self, f: F) where B: Ord, F: FnMut(&T) -> B

Sorts the slice, in place, using key to extract a key by which to order the sort by.

This sort is stable and O(n log n) worst-case but allocates approximately 2 * n, where n is the length of self.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

v.sort_by_key(|k| k.abs());
assert!(v == [1, 2, -3, 4, -5]);

fn sort_by<F>(&mut self, compare: F) where F: FnMut(&T, &T) -> Ordering

Sorts the slice, in place, using compare to compare elements.

This sort is stable and O(n log n) worst-case but allocates approximately 2 * n, where n is the length of self.

Examples

let mut v = [5, 4, 1, 3, 2];
v.sort_by(|a, b| a.cmp(b));
assert!(v == [1, 2, 3, 4, 5]);

// reverse sorting
v.sort_by(|a, b| b.cmp(a));
assert!(v == [5, 4, 3, 2, 1]);

fn clone_from_slice(&mut self, src: &[T]) where T: Clone

Copies the elements from src into self.

The length of this slice must be the same as the slice passed in.

Panics

This function will panic if the two slices have different lengths.

Example

let mut dst = [0, 0, 0];
let src = [1, 2, 3];

dst.clone_from_slice(&src);
assert!(dst == [1, 2, 3]);

fn copy_from_slice(&mut self, src: &[T]) where T: Copy

Copies all elements from src into self, using a memcpy.

The length of src must be the same as self.

Panics

This function will panic if the two slices have different lengths.

Example

let mut dst = [0, 0, 0];
let src = [1, 2, 3];

dst.copy_from_slice(&src);
assert_eq!(src, dst);

fn to_vec(&self) -> Vec<T> where T: Clone

Copies self into a new Vec.

fn into_vec(self: Box<[T]>) -> Vec<T>

Converts self into a vector without clones or allocation.

Trait Implementations

impl<'l, T: Element> From<&'l Banded<T>> for Conventional<T>

fn from(matrix: &'l Banded<T>) -> Self

Performs the conversion.

impl<T: Element> From<Banded<T>> for Conventional<T>

fn from(matrix: Banded<T>) -> Self

Performs the conversion.

impl<'l, T: Element> From<&'l Compressed<T>> for Conventional<T>

fn from(matrix: &'l Compressed<T>) -> Self

Performs the conversion.

impl<T: Element> From<Compressed<T>> for Conventional<T>

fn from(matrix: Compressed<T>) -> Self

Performs the conversion.

impl<'l, T> MultiplyInto<Compressed<T>, [T]> for Conventional<T> where T: Element + Number

fn multiply_into(&self, right: &Compressed<T>, result: &mut [T])

Perform the multiplication.

impl<T: Element> Into<Vec<T>> for Conventional<T>

fn into(self) -> Vec<T>

Performs the conversion.

impl<T> MultiplySelf<Diagonal<T>> for Conventional<T> where T: Element + Number

fn multiply_self(&mut self, right: &Diagonal<T>)

Perform the multiplication.

impl<T: Element> Transpose for Conventional<T>

fn transpose(&self) -> Self

Perform the transpose.

impl<T: Element> Size for Conventional<T>

fn rows(&self) -> usize

Return the number of rows.

fn columns(&self) -> usize

Return the number of columns.

fn dimensions(&self) -> (usize, usize)

Return the number of rows and columns.

impl<T: Element> Matrix for Conventional<T>

type Element = T

The element type.

fn nonzeros(&self) -> usize

Count nonzero elements.

fn zero<S: Size>(size: S) -> Self

Create a zero matrix.

impl<T: Element, P: Position> Index<P> for Conventional<T>

type Output = T

The returned type after indexing

fn index(&self, index: P) -> &Self::Output

The method for the indexing (Foo[Bar]) operation

impl<T: Element, P: Position> IndexMut<P> for Conventional<T>

fn index_mut(&mut self, index: P) -> &mut Self::Output

The method for the indexing (Foo[Bar]) operation

impl<T: Element> Deref for Conventional<T>

type Target = [T]

The resulting type after dereferencing

fn deref(&self) -> &Self::Target

The method called to dereference a value

impl<T: Element> DerefMut for Conventional<T>

fn deref_mut(&mut self) -> &mut Self::Target

The method called to mutably dereference a value

impl<'l, T: Element> From<&'l Diagonal<T>> for Conventional<T>

fn from(matrix: &Diagonal<T>) -> Self

Performs the conversion.

impl<T: Element> From<Diagonal<T>> for Conventional<T>

fn from(matrix: Diagonal<T>) -> Self

Performs the conversion.

impl<'l, T: Element> From<&'l Packed<T>> for Conventional<T>

fn from(matrix: &'l Packed<T>) -> Self

Performs the conversion.

impl<T: Element> From<Packed<T>> for Conventional<T>

fn from(matrix: Packed<T>) -> Self

Performs the conversion.

Derived Implementations

impl<T: PartialEq + Element> PartialEq for Conventional<T>

fn eq(&self, __arg_0: &Conventional<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Conventional<T>) -> bool

This method tests for !=.

impl<T: Debug + Element> Debug for Conventional<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Clone + Element> Clone for Conventional<T>

fn clone(&self) -> Conventional<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.