Struct CsMatrix &nbsp; Copy item path

impl<T, R, C> CsMatrix<T, R, C>
where T: Scalar, R: Dim, C: Dim, DefaultAllocator: Allocator<usize, C>,

pub fn new_uninitialized_generic( nrows: R, ncols: C, nvals: usize, ) -> CsMatrix<T, R, C>

Creates a new compressed sparse column matrix with the specified dimension and nvals possible non-zero values.

impl<T, R, C, S> CsMatrix<T, R, C, S>
where T: Scalar, R: Dim, C: Dim, S: CsStorage<T, R, C>,

pub fn len(&self) -> usize

The size of the data buffer.

pub fn nrows(&self) -> usize

The number of rows of this matrix.

pub fn ncols(&self) -> usize

The number of rows of this matrix.

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

The shape of this matrix.

pub fn is_square(&self) -> bool

Whether this matrix is square or not.

pub fn is_sorted(&self) -> bool

Should always return true.

This method is generally used for debugging and should typically not be called in user code. This checks that the row inner indices of this matrix are sorted. It takes O(n) time, where nisself.len(). All operations of CSC matrices on nalgebra assume, and will return, sorted indices. If at any time this is_sortedmethod returnsfalse`, then, something went wrong and an issue should be open on the nalgebra repository with details on how to reproduce this.

pub fn transpose(&self) -> CsMatrix<T, C, R>
where DefaultAllocator: Allocator<usize, R>,

Computes the transpose of this sparse matrix.

impl<T, R, C, S> CsMatrix<T, R, C, S>
where T: Scalar, R: Dim, C: Dim, S: CsStorageMut<T, R, C>,

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut T>

Iterator through all the mutable values of this sparse matrix.

impl<'a, T> CsMatrix<T>
where T: Scalar + Zero + ClosedAdd,

pub fn from_triplet( nrows: usize, ncols: usize, irows: &[usize], icols: &[usize], vals: &[T], ) -> CsMatrix<T>

Creates a column-compressed sparse matrix from a sparse matrix in triplet form.

impl<'a, T, R, C> CsMatrix<T, R, C>
where T: Scalar + Zero + ClosedAdd, R: Dim, C: Dim, DefaultAllocator: Allocator<usize, C> + Allocator<T, R>,

pub fn from_triplet_generic( nrows: R, ncols: C, irows: &[usize], icols: &[usize], vals: &[T], ) -> CsMatrix<T, R, C>

Creates a column-compressed sparse matrix from a sparse matrix in triplet form.

impl<T, D, S> CsMatrix<T, D, D, S>
where T: RealField, D: Dim, S: CsStorage<T, D, D>,

pub fn solve_lower_triangular<R2, C2, S2>( &self, b: &Matrix<T, R2, C2, S2>, ) -> Option<Matrix<T, R2, C2, <DefaultAllocator as Allocator<T, R2, C2>>::Buffer>>
where R2: Dim, C2: Dim, S2: Storage<T, R2, C2>, DefaultAllocator: Allocator<T, R2, C2>, ShapeConstraint: SameNumberOfRows<D, R2>,

Solve a lower-triangular system with a dense right-hand-side.

pub fn tr_solve_lower_triangular<R2, C2, S2>( &self, b: &Matrix<T, R2, C2, S2>, ) -> Option<Matrix<T, R2, C2, <DefaultAllocator as Allocator<T, R2, C2>>::Buffer>>
where R2: Dim, C2: Dim, S2: Storage<T, R2, C2>, DefaultAllocator: Allocator<T, R2, C2>, ShapeConstraint: SameNumberOfRows<D, R2>,

Solve a lower-triangular system with self transposed and a dense right-hand-side.

pub fn solve_lower_triangular_mut<R2, C2, S2>( &self, b: &mut Matrix<T, R2, C2, S2>, ) -> bool
where R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>, ShapeConstraint: SameNumberOfRows<D, R2>,

Solve in-place a lower-triangular system with a dense right-hand-side.

pub fn tr_solve_lower_triangular_mut<R2, C2, S2>( &self, b: &mut Matrix<T, R2, C2, S2>, ) -> bool
where R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>, ShapeConstraint: SameNumberOfRows<D, R2>,

Solve a lower-triangular system with self transposed and a dense right-hand-side.

pub fn solve_lower_triangular_cs<D2, S2>( &self, b: &CsMatrix<T, D2, Const<1>, S2>, ) -> Option<CsMatrix<T, D2, Const<1>>>
where D2: Dim, S2: CsStorage<T, D2>, DefaultAllocator: Allocator<bool, D> + Allocator<T, D2> + Allocator<usize, D2>, ShapeConstraint: SameNumberOfRows<D, D2>,

Solve a lower-triangular system with a sparse right-hand-side.

Trait Implementations§

impl<'a, 'b, T, R1, R2, C1, C2, S1, S2> Add<&'b CsMatrix<T, R2, C2, S2>> for &'a CsMatrix<T, R1, C1, S1>
where T: Scalar + ClosedAdd + ClosedMul + Zero + One, R1: Dim, C1: Dim, R2: Dim, C2: Dim, S1: CsStorage<T, R1, C1>, S2: CsStorage<T, R2, C2>, ShapeConstraint: DimEq<R1, R2> + DimEq<C1, C2>, DefaultAllocator: Allocator<usize, C2> + Allocator<usize, R1> + Allocator<T, R1>,

type Output = CsMatrix<T, R1, C2>

The resulting type after applying the + operator.

fn add( self, rhs: &'b CsMatrix<T, R2, C2, S2>, ) -> <&'a CsMatrix<T, R1, C1, S1> as Add<&'b CsMatrix<T, R2, C2, S2>>>::Output

Performs the + operation. Read more

impl<T, R, C, S> Clone for CsMatrix<T, R, C, S>
where T: Clone + Scalar, R: Clone + Dim, C: Clone + Dim, S: Clone + CsStorage<T, R, C>,

fn clone(&self) -> CsMatrix<T, R, C, S>

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<T, R, C, S> Debug for CsMatrix<T, R, C, S>
where T: Debug + Scalar, R: Debug + Dim, C: Debug + Dim, S: Debug + CsStorage<T, R, C>,

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

Formats the value using the given formatter. Read more

impl<'a, T, R, C, S> From<CsMatrix<T, R, C, S>> for Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
where T: Scalar + Zero, R: Dim, C: Dim, S: CsStorage<T, R, C>, DefaultAllocator: Allocator<T, R, C>,

fn from( m: CsMatrix<T, R, C, S>, ) -> Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>

Converts to this type from the input type.

impl<'a, T, R, C, S> From<Matrix<T, R, C, S>> for CsMatrix<T, R, C>
where T: Scalar + Zero, R: Dim, C: Dim, S: Storage<T, R, C>, DefaultAllocator: Allocator<T, R, C> + Allocator<usize, C>,

fn from(m: Matrix<T, R, C, S>) -> CsMatrix<T, R, C>

Converts to this type from the input type.

impl<'a, 'b, T, R1, R2, C1, C2, S1, S2> Mul<&'b CsMatrix<T, R2, C2, S2>> for &'a CsMatrix<T, R1, C1, S1>
where T: Scalar + ClosedAdd + ClosedMul + Zero, R1: Dim, C1: Dim, R2: Dim, C2: Dim, S1: CsStorage<T, R1, C1>, S2: CsStorage<T, R2, C2>, ShapeConstraint: AreMultipliable<R1, C1, R2, C2>, DefaultAllocator: Allocator<usize, C2> + Allocator<usize, R1> + Allocator<T, R1>,

type Output = CsMatrix<T, R1, C2>

The resulting type after applying the * operator.

fn mul( self, rhs: &'b CsMatrix<T, R2, C2, S2>, ) -> <&'a CsMatrix<T, R1, C1, S1> as Mul<&'b CsMatrix<T, R2, C2, S2>>>::Output

Performs the * operation. Read more

impl<'a, 'b, T, R, C, S> Mul<T> for CsMatrix<T, R, C, S>
where T: Scalar + ClosedAdd + ClosedMul + Zero, R: Dim, C: Dim, S: CsStorageMut<T, R, C>,

type Output = CsMatrix<T, R, C, S>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <CsMatrix<T, R, C, S> as Mul<T>>::Output

Performs the * operation. Read more

impl<T, R, C, S> PartialEq for CsMatrix<T, R, C, S>
where T: PartialEq + Scalar, R: PartialEq + Dim, C: PartialEq + Dim, S: PartialEq + CsStorage<T, R, C>,

fn eq(&self, other: &CsMatrix<T, R, C, S>) -> 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<T, R, C, S> StructuralPartialEq for CsMatrix<T, R, C, S>
where T: Scalar, R: Dim, C: Dim, S: CsStorage<T, R, C>,

Auto Trait Implementations§

impl<T, R, C, S> Freeze for CsMatrix<T, R, C, S>
where S: Freeze,

impl<T, R, C, S> RefUnwindSafe for CsMatrix<T, R, C, S>
where S: RefUnwindSafe, T: RefUnwindSafe, R: RefUnwindSafe, C: RefUnwindSafe,

impl<T, R, C, S> Send for CsMatrix<T, R, C, S>
where S: Send, T: Send,

impl<T, R, C, S> Sync for CsMatrix<T, R, C, S>
where S: Sync, T: Sync,

impl<T, R, C, S> Unpin for CsMatrix<T, R, C, S>
where S: Unpin, T: Unpin, R: Unpin, C: Unpin,

impl<T, R, C, S> UnsafeUnpin for CsMatrix<T, R, C, S>
where S: UnsafeUnpin,

impl<T, R, C, S> UnwindSafe for CsMatrix<T, R, C, S>
where S: UnwindSafe, T: UnwindSafe, R: UnwindSafe, C: 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<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> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into 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<T> Same for T

type Output = T

Should always be Self

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<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, U> TryFrom 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>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> UserData for T
where T: Clone + Any + Send + Sync,

fn clone_boxed(&self) -> Box<dyn UserData>

Clone this trait-object.

fn to_any(&self) -> Box<dyn Any + Send + Sync>

Clone as its super-trait trait objects.

fn as_any(&self) -> &(dyn Any + Send + Sync + 'static)

Downcast to Any.

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> Component for T
where T: Send + Sync + 'static,

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