Skip to main content

DenseMatrix

Struct DenseMatrix 

Source
pub struct DenseMatrix<S> { /* private fields */ }
Expand description

A dynamically sized, heap-backed row-major dense matrix.

Implementations§

Source§

impl<S: BaseScalar> DenseMatrix<S>

Source

pub fn from_row_major_vec( rows: usize, cols: usize, data: Vec<S>, ) -> Result<Self, SolverError>

Build a rows×cols matrix from row-major data (no memory limit).

Source

pub fn from_row_major_vec_with_options( rows: usize, cols: usize, data: Vec<S>, options: DenseIngestOptions, ) -> Result<Self, SolverError>

Build a rows×cols matrix from row-major data, rejecting an element count over max_elements with SolverError::InvalidInput.

Source

pub fn dims(&self) -> Dim2

The matrix dimensions.

Source§

impl<S: FiniteScalar> DenseMatrix<S>

Source

pub fn validate_finite(&self) -> Result<(), SolverError>

Scan for non-finite elements, returning NonFiniteInput on the first.

Trait Implementations§

Source§

impl<S: Clone> Clone for DenseMatrix<S>

Source§

fn clone(&self) -> DenseMatrix<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
Source§

impl<S: BaseScalar> ContiguousMatrixAccess for DenseMatrix<S>

Source§

fn as_row_major(&self) -> Option<&[S]>

The row-major contiguous backing of length rows * cols, or None if storage is not row-major contiguous.
Source§

impl<S: Debug> Debug for DenseMatrix<S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: BaseScalar> MatrixAccess for DenseMatrix<S>

Source§

type Scalar = S

The element type, constrained to the base scalar capability tier.
Source§

fn dims(&self) -> Dim2

The shape as a row/column pair.
Source§

fn dimension_kind(&self) -> DimensionKind

Whether the shape is known at compile time or at run time.
Source§

fn get(&self, row: usize, col: usize) -> Result<S, SolverError>

The element at (row, col), or SolverError::DimensionMismatch if the coordinate is out of range. Bounds are checked row first, then column: a row violation reports { lhs: row, rhs: rows }, a column violation reports { lhs: col, rhs: cols }. The payload does not encode which axis failed; the caller distinguishes that from the access context.
Source§

impl<S: BaseScalar> MatrixAccessMut for DenseMatrix<S>

Source§

fn set(&mut self, row: usize, col: usize, value: S) -> Result<(), SolverError>

Write value at (row, col), under the same bounds contract as MatrixAccess::get.

Auto Trait Implementations§

§

impl<S> Freeze for DenseMatrix<S>

§

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

§

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

§

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

§

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

§

impl<S> UnsafeUnpin for DenseMatrix<S>

§

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

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.