Skip to main content

SpMat

yui_matrix::sparse

Struct SpMat

pub struct SpMat<R> { /* private fields */ }

Implementations§

impl<R> SpMat<R>

pub fn data(&self) -> (&[usize], &[usize], &[R])

pub fn disassemble(self) -> (Vec<usize>, Vec<usize>, Vec<R>)

pub fn zero(shape: (usize, usize)) -> Self

pub fn is_zero(&self) -> bool
where R: Zero,

pub fn id(n: usize) -> Self
where R: Scalar + One,

pub fn is_id(&self) -> bool
where R: Scalar + One + Zero,

pub fn is_triang(&self, t: TriangularType) -> bool
where R: Zero,

pub fn iter(&self) -> impl Iterator<Item = (usize, usize, &R)>

pub fn iter_nz(&self) -> impl Iterator<Item = (usize, usize, &R)>
where R: Zero,

pub fn into_dense(self) -> Mat<R>
where R: Scalar + Zero + ClosedAddAssign,

pub fn nnz(&self) -> usize

pub fn density(&self) -> f64

pub fn redundancy(&self) -> f64
where R: Zero,

pub fn mean_weight(&self) -> f64
where R: Ring, for<'x> &'x R: RingOps<R>,

impl<R> SpMat<R>
where R: Scalar + Clone + Zero + ClosedAddAssign,

pub fn from_entries<T>(shape: (usize, usize), entries: T) -> Self
where T: IntoIterator<Item = (usize, usize, R)>,

pub fn from_col_vecs<I>(nrows: usize, vecs: I) -> Self
where I: IntoIterator<Item = SpVec<R>>,

pub fn from_dense_data<I>(shape: (usize, usize), data: I) -> Self
where I: IntoIterator<Item = R>,

pub fn col_vec(&self, j: usize) -> SpVec<R>
where R: Scalar + Zero + ClosedAddAssign,

pub fn transpose(&self) -> Self

pub fn extract<F>(&self, shape: (usize, usize), f: F) -> SpMat<R>
where F: Fn(usize, usize) -> Option<(usize, usize)>,

pub fn permute(&self, p: PermView<'_>, q: PermView<'_>) -> SpMat<R>

pub fn permute_rows(&self, p: PermView<'_>) -> SpMat<R>

pub fn permute_cols(&self, q: PermView<'_>) -> SpMat<R>

pub fn submat(&self, rows: Range<usize>, cols: Range<usize>) -> SpMat<R>

pub fn submat_rows(&self, rows: Range<usize>) -> SpMat<R>

pub fn submat_cols(&self, cols: Range<usize>) -> SpMat<R>

pub fn divide4(&self, point: (usize, usize)) -> [SpMat<R>; 4]

pub fn combine_blocks(blocks: [&SpMat<R>; 4]) -> SpMat<R>

pub fn concat(&self, b: &Self) -> Self

pub fn stack(&self, b: &Self) -> Self

pub fn extend_cols(&mut self, b: Self)

pub fn from_row_perm(p: PermView<'_>) -> Self
where R: One,

pub fn from_col_perm(p: PermView<'_>) -> Self
where R: One,

Trait Implementations§

impl<'a, 'b, R> Add for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the + operator.

fn add(self, rhs: SpMat<R>) -> Self::Output

Performs the + operation. Read more

impl<'a, 'b, R> Add<&'b SpMat<R>> for &'a SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the + operator.

fn add(self, rhs: &'b SpMat<R>) -> Self::Output

Performs the + operation. Read more

impl<'a, 'b, R> Add<&'b SpMat<R>> for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the + operator.

fn add(self, rhs: &'b SpMat<R>) -> Self::Output

Performs the + operation. Read more

impl<'a, 'b, R> Add<SpMat<R>> for &'a SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the + operator.

fn add(self, rhs: SpMat<R>) -> Self::Output

Performs the + operation. Read more

impl<'a, 'b, R> AddAssign for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

fn add_assign(&mut self, rhs: SpMat<R>)

Performs the += operation. Read more

impl<'a, 'b, R> AddAssign<&'b SpMat<R>> for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

fn add_assign(&mut self, rhs: &'b SpMat<R>)

Performs the += operation. Read more

impl<R: Clone> Clone for SpMat<R>

fn clone(&self) -> SpMat<R>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<R> Debug for SpMat<R>
where R: Display + Debug,

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

Formats the value using the given formatter. Read more

impl<R> Default for SpMat<R>

fn default() -> Self

Returns the “default value” for a type. Read more

impl<R> Display for SpMat<R>
where R: Display + Debug,

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

Formats the value using the given formatter. Read more

impl<R: Eq> Eq for SpMat<R>

impl<R> From<CscMatrix<R>> for SpMat<R>

fn from(inner: CscMatrix<R>) -> Self

Converts to this type from the input type.

impl<R> From<Mat<R>> for SpMat<R>
where R: Scalar + Zero,

fn from(value: Mat<R>) -> Self

Converts to this type from the input type.

impl<R> From<SpMat<R>> for Mat<R>
where R: Scalar + Zero + ClosedAddAssign,

fn from(value: SpMat<R>) -> Self

Converts to this type from the input type.

impl<R> From<SpVec<R>> for SpMat<R>

fn from(vec: SpVec<R>) -> Self

Converts to this type from the input type.

impl<R> MatTrait for SpMat<R>

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

fn nrows(&self) -> usize

fn ncols(&self) -> usize

fn is_square(&self) -> bool

impl<'a, 'b, R> Mul for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the * operator.

fn mul(self, rhs: SpMat<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<&'b SpMat<R>> for &'a SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b SpMat<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<&'b SpMat<R>> for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b SpMat<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<&'b SpVec<R>> for &'a SpMat<R>
where R: Ring, for<'x> &'x R: RingOps<R>,

type Output = SpVec<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b SpVec<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<&'b SpVec<R>> for SpMat<R>
where R: Ring, for<'x> &'x R: RingOps<R>,

type Output = SpVec<R>

The resulting type after applying the * operator.

fn mul(self, rhs: &'b SpVec<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<SpMat<R>> for &'a SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the * operator.

fn mul(self, rhs: SpMat<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<SpVec<R>> for &'a SpMat<R>
where R: Ring, for<'x> &'x R: RingOps<R>,

type Output = SpVec<R>

The resulting type after applying the * operator.

fn mul(self, rhs: SpVec<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> Mul<SpVec<R>> for SpMat<R>
where R: Ring, for<'x> &'x R: RingOps<R>,

type Output = SpVec<R>

The resulting type after applying the * operator.

fn mul(self, rhs: SpVec<R>) -> Self::Output

Performs the * operation. Read more

impl<'a, 'b, R> MulAssign for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

fn mul_assign(&mut self, rhs: SpMat<R>)

Performs the *= operation. Read more

impl<'a, 'b, R> MulAssign<&'b SpMat<R>> for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

fn mul_assign(&mut self, rhs: &'b SpMat<R>)

Performs the *= operation. Read more

impl<R> Neg for &SpMat<R>
where R: Scalar + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

impl<R> Neg for SpMat<R>
where R: Scalar + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

impl<R: PartialEq> PartialEq for SpMat<R>

fn eq(&self, other: &SpMat<R>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R> StructuralPartialEq for SpMat<R>

impl<'a, 'b, R> Sub for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the - operator.

fn sub(self, rhs: SpMat<R>) -> Self::Output

Performs the - operation. Read more

impl<'a, 'b, R> Sub<&'b SpMat<R>> for &'a SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the - operator.

fn sub(self, rhs: &'b SpMat<R>) -> Self::Output

Performs the - operation. Read more

impl<'a, 'b, R> Sub<&'b SpMat<R>> for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the - operator.

fn sub(self, rhs: &'b SpMat<R>) -> Self::Output

Performs the - operation. Read more

impl<'a, 'b, R> Sub<SpMat<R>> for &'a SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

type Output = SpMat<R>

The resulting type after applying the - operator.

fn sub(self, rhs: SpMat<R>) -> Self::Output

Performs the - operation. Read more

impl<'a, 'b, R> SubAssign for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

fn sub_assign(&mut self, rhs: SpMat<R>)

Performs the -= operation. Read more

impl<'a, 'b, R> SubAssign<&'b SpMat<R>> for SpMat<R>
where R: Scalar + ClosedAddAssign + ClosedSubAssign + ClosedMulAssign + Zero + One + Neg<Output = R>,

fn sub_assign(&mut self, rhs: &'b SpMat<R>)

Performs the -= operation. Read more

Auto Trait Implementations§

impl<R> Freeze for SpMat<R>

impl<R> RefUnwindSafe for SpMat<R>
where R: RefUnwindSafe,

impl<R> Send for SpMat<R>
where R: Send,

impl<R> Sync for SpMat<R>
where R: Sync,

impl<R> Unpin for SpMat<R>
where R: Unpin,

impl<R> UnsafeUnpin for SpMat<R>

impl<R> UnwindSafe for SpMat<R>
where R: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneAnd for T
where T: Clone,

fn clone_and<F>(&self, f: F) -> Self
where F: FnOnce(&mut Self),

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T, Right> ClosedAdd<Right> for T
where T: Add<Right, Output = T> + AddAssign<Right>,

impl<T, Right> ClosedAdd<Right> for T
where T: Add<Right, Output = T> + AddAssign<Right>,

impl<T, Right> ClosedAddAssign<Right> for T
where T: ClosedAdd<Right> + AddAssign<Right>,

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

impl<T, Right> ClosedMulAssign<Right> for T
where T: ClosedMul<Right> + MulAssign<Right>,

impl<T> ClosedNeg for T
where T: Neg<Output = T>,

impl<T> ClosedNeg for T
where T: Neg<Output = T>,

impl<T, Right> ClosedSub<Right> for T
where T: Sub<Right, Output = T> + SubAssign<Right>,

impl<T, Right> ClosedSub<Right> for T
where T: Sub<Right, Output = T> + SubAssign<Right>,

impl<T, Right> ClosedSubAssign<Right> for T
where T: ClosedSub<Right> + SubAssign<Right>,

impl<T> ElemBase for T
where T: Default + PartialEq + Eq + Clone + Send + Sync + Display + Debug + 'static,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<N, A, B> MulAcc<A, B> for N
where &'x A: for<'x> Mul<&'x B, Output = N>, N: AddAssign,

fn mul_acc(&mut self, a: &A, b: &B)

Multiply and accumulate in this variable, formally *self += a * b.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.