Back to Eqiora docs Skip to main content

CsrMatrix

eqiora::assembly

Struct CsrMatrix 

pub struct CsrMatrix<S> { /* private fields */ }
Description

Immutable compressed sparse row matrix.

Implementations§

§

impl<S> CsrMatrix<S>
where S: Scalar + ComplexFloat + Sync,

Signature links:§CsrMatrixScalarComplexFloatSync

pub fn from_sorted_csr( rows: usize, columns: usize, row_offsets: Vec<usize>, column_indices: Vec<usize>, values: Vec<S>, ) -> Result<CsrMatrix<S>, Diagnostic>

Signature links:from_sorted_csrusizeusizeVecusizeVecusizeVecResultCsrMatrixDiagnostic

Construct validated CSR storage with strictly ordered columns per row.

This is the single admission boundary for finalized sparse storage. Callers retain no mutable access to the admitted arrays, so row lookup and backend adapters may rely on the checked ordering thereafter.

§Errors

Returns EQ0806 for zero or inconsistent shape, invalid row offsets, out-of-range or non-increasing columns, or a non-finite value.

pub const fn rows(&self) -> usize

Signature links:rowsusize

Row count.

pub const fn columns(&self) -> usize

Signature links:columnsusize

Column count.

pub fn row_offsets(&self) -> &[usize]

Signature links:row_offsetsusize

CSR row offsets.

pub fn column_indices(&self) -> &[usize]

Signature links:column_indicesusize

CSR column indices.

pub fn values(&self) -> &[S]

Signature links:values[S]

CSR nonzero values.

pub fn multiply(&self, input: &[S]) -> Result<Vec<S>, Diagnostic>

Signature links:multiply[S]ResultVecDiagnostic

Multiply by a dense vector.

§Errors

Returns EQ0802 for the wrong input size, non-finite input, or a non-finite result.

pub fn multiply_into( &self, input: &[S], output: &mut [S], ) -> Result<(), Diagnostic>

Signature links:multiply_into[S][S]Result()Diagnostic

Multiply into caller-owned storage without allocating.

§Errors

Returns EQ0802 for a shape mismatch, non-finite input, or a non-finite result.

pub fn entry(&self, row: usize, column: usize) -> Option<S>

Signature links:entryusizeusizeOption

Read one matrix entry; structural zeros return zero.

Trait Implementations§

§

impl<S> Clone for CsrMatrix<S>
where S: Clone,

Signature links:§CloneCsrMatrixClone
§

fn clone(&self) -> CsrMatrix<S>

Signature links:§cloneCsrMatrix
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Signature links:unstableSource§clone_from
Performs copy-assignment from source. Read more
§

impl<S> CsrStorage<S> for CsrMatrix<S>

Signature links:§CsrStorageCsrMatrix
§

fn rows(&self) -> usize

Signature links:§rowsusize
Matrix row count.
§

fn columns(&self) -> usize

Signature links:§columnsusize
Matrix column count.
§

fn row_offsets(&self) -> &[usize]

Signature links:§row_offsetsusize
CSR row offsets.
§

fn column_indices(&self) -> &[usize]

Signature links:§column_indicesusize
CSR column indices.
§

fn values(&self) -> &[S]

Signature links:§values[S]
CSR nonzero values, in stored reduction order.
§

impl<S> Debug for CsrMatrix<S>
where S: Debug,

Signature links:§DebugCsrMatrixDebug
§

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

Signature links:§fmtFormatterResult()Error
Formats the value using the given formatter. Read more
§

impl<S> LinearOperator for CsrMatrix<S>
where S: Scalar + ComplexFloat + Sync,

Signature links:§LinearOperatorCsrMatrixScalarComplexFloatSync
§

type Scalar = S

Signature links:§Scalar
Arithmetic value in each mathematical coordinate.
§

fn rows(&self) -> usize

Signature links:§rowsusize
Output dimension.
§

fn columns(&self) -> usize

Signature links:§columnsusize
Input dimension.
§

fn apply(&self, input: &[S], output: &mut [S]) -> Result<(), Diagnostic>

Signature links:§apply[S][S]Result()Diagnostic
Compute output = self * input. Read more
§

fn row_action(&self) -> Option<&dyn RowLinearAction<Scalar = S>>

Signature links:§row_actionOptionRowLinearAction
Expose independently executable row ranges when the realization has that capability. Read more
§

fn diagonal(&self, output: &mut [S]) -> Result<DiagonalAvailability, Diagnostic>

Signature links:§diagonal[S]ResultDiagonalAvailabilityDiagnostic
Write the operator diagonal when it is naturally available. Read more
§

fn orientation(&self) -> LinearOperatorOrientation

Signature links:§orientationLinearOperatorOrientation
Orientation represented by this callable action. Read more
§

impl<S> OrientedLinearOperator for CsrMatrix<S>
where S: Scalar + ComplexFloat + Sync,

Signature links:§OrientedLinearOperatorCsrMatrixScalarComplexFloatSync
§

fn supports_orientation(&self, _orientation: LinearOperatorOrientation) -> bool

Signature links:§supports_orientationLinearOperatorOrientationbool
Whether this exact action is available before numerical work begins.
§

fn apply_oriented( &self, orientation: LinearOperatorOrientation, input: &[S], output: &mut [S], ) -> Result<(), Diagnostic>

Signature links:§apply_orientedLinearOperatorOrientation[S][S]Result()Diagnostic
Apply the requested mathematical orientation. Read more
§

impl<S> PartialEq for CsrMatrix<S>
where S: PartialEq,

Signature links:§PartialEqCsrMatrixPartialEq
§

fn eq(&self, other: &CsrMatrix<S>) -> bool

Signature links:§eqCsrMatrixbool
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

Signature links:unstableSource§ne&Rhsbool
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<S> RowLinearAction for CsrMatrix<S>
where S: Scalar + ComplexFloat + Sync,

Signature links:§RowLinearActionCsrMatrixScalarComplexFloatSync
§

type Scalar = S

Signature links:§Scalar
Value stored in each input and output coordinate.
§

fn apply_rows( &self, rows: Range<usize>, input: &[S], output: &mut [S], ) -> Result<(), Diagnostic>

Signature links:§apply_rowsRangeusize[S][S]Result()Diagnostic
Compute one contiguous output-row range without allocating. Read more
§

impl<S> StructuralPartialEq for CsrMatrix<S>

Auto Trait Implementations§

§

impl<S> Freeze for CsrMatrix<S>

§

impl<S> RefUnwindSafe for CsrMatrix<S>
where S: RefUnwindSafe,

§

impl<S> Send for CsrMatrix<S>
where S: Send,

§

impl<S> Sync for CsrMatrix<S>
where S: Sync,

§

impl<S> Unpin for CsrMatrix<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for CsrMatrix<S>

§

impl<S> UnwindSafe for CsrMatrix<S>
where S: UnwindSafe,

Blanket Implementations§

Source§

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

Signature links:Source§AnySized
Source§

fn type_id(&self) -> TypeId

Signature links:Source§type_idTypeId
Gets the TypeId of self. Read more
§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Signature links:§Result
Convert the given value into an approximately equivalent representation.
§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

Signature links:§
§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Signature links:§Result
Convert the subject into an approximately equivalent representation.
Source§

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

Signature links:Source§BorrowSized
Source§

fn borrow(&self) -> &T

Signature links:Source§borrow&T
Immutably borrows from an owned value. Read more
Source§

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

Signature links:Source§BorrowMutSized
Source§

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

Signature links:Source§borrow_mut&mut T
Mutably borrows from an owned value. Read more
§

impl<T> ByRef<T> for T

Signature links:§
§

fn by_ref(&self) -> &T

Source§

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

Signature links:Source§CloneToUninitClone
Source§

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

Signature links:Source§clone_to_uninit*mut u8
🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T, Dst> ConvAsUtil<Dst> for T

Signature links:§
§

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject with the default scheme.
§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject with a specific scheme.
§

impl<T> ConvUtil for T

Signature links:§
§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Signature links:§ResultSized
Approximate the subject to a given type with the default scheme.
§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Signature links:§ResultSized
Approximate the subject to a given type with a specific scheme.
§

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Signature links:§SizedInto
Convert the subject to a given type.
§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Signature links:§ResultSized
Attempt to convert the subject to a given type.
§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Signature links:§ResultSized
Attempt a value conversion of the subject to a given type.
§

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

Signature links:§Sized
§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Signature links:Source§From
Source§

fn from(t: T) -> T

Signature links:Source§from

Returns the argument unchanged.

§

impl<T> Instrument for T

Signature links:§
§

fn instrument(self, span: Span) -> Instrumented<Self>

Signature links:§
Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Signature links:§
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Signature links:Source§IntoFrom
Source§

fn into(self) -> U

Signature links:Source§into

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Signature links:Source§IntoEither
Source§

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

Signature links:Source§into_eitherboolEither
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
Source§

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

Signature links:Source§into_either_withEitherFnOncebool
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> Pointable for T

Signature links:§
§

const ALIGN: usize

Signature links:§usize
The alignment of pointer.
§

type Init = T

Signature links:§
The type for initializers.
§

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

Signature links:§usize
Initializes a with the given initializer. Read more
§

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

Signature links:§usize&'a T
Dereferences the given pointer. Read more
§

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

Signature links:§usize&'a mut T
Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Signature links:§usize
Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Signature links:Source§Same
Source§

type Output = T

Signature links:Source§Output
Should always be Self
§

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

Signature links:§
§

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

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

fn is_in_subset(&self) -> bool

Signature links:§bool
Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

Signature links:§&SS
The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Signature links:Source§ToOwnedClone
Source§

type Owned = T

Signature links:Source§Owned
The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Signature links:Source§to_owned
Creates owned data from borrowed data, usually by cloning. Read more
Source§

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

Signature links:Source§clone_into&mut T
Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<Src> TryFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Signature links:§Result
Convert the given value into the subject type.
Source§

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

Signature links:Source§TryFromInto
Source§

type Error = Infallible

Signature links:Source§ErrorInfallible
The type returned in the event of a conversion error.
Source§

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

Signature links:Source§try_fromResultTryFromError
Performs the conversion.
§

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

Signature links:§
§

type Err = <Dst as TryFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Signature links:§Result
Convert the subject into the destination type.
Source§

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

Signature links:Source§TryIntoTryFrom
Source§

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

Signature links:Source§ErrorTryFromError
The type returned in the event of a conversion error.
Source§

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

Signature links:Source§try_intoResultTryFromError
Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Signature links:§
§

fn vzip(self) -> V

§

impl<Src> ValueFrom<Src> for Src

Signature links:§
§

type Err = NoError

Signature links:§
The error type produced by a failed conversion.
§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Signature links:§Result
Convert the given value into an exactly equivalent representation.
§

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

Signature links:§
§

type Err = <Dst as ValueFrom<Src>>::Err

Signature links:§
The error type produced by a failed conversion.
§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Signature links:§Result
Convert the subject into an exactly equivalent representation.
§

impl<T> WithSubscriber for T

Signature links:§
§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Signature links:§Into
Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Signature links:§
Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. 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, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

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

Source§

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