extendr_api::prelude::utils::constrained::mat

Struct MatRef

#[repr(transparent)]
pub struct MatRef<'nrows, 'ncols, 'a, E>(Branded<'ncols, Branded<'nrows, MatRef<'a, E>>>)
where
    E: Entity;
Expand description

Immutable dense matrix view with dimensions equal to the values tied to ('nrows, 'ncols).

Tuple Fields§

§0: Branded<'ncols, Branded<'nrows, MatRef<'a, E>>>

Implementations§

§

impl<'nrows, 'ncols, 'a, E> MatRef<'nrows, 'ncols, 'a, E>
where E: Entity,

pub fn new( inner: MatRef<'a, E>, nrows: Size<'nrows>, ncols: Size<'ncols>, ) -> MatRef<'nrows, 'ncols, 'a, E>

Returns a new matrix view after checking that its dimensions match the dimensions tied to ('nrows, 'ncols).

pub fn nrows(&self) -> Size<'nrows>

Returns the number of rows of the matrix.

pub fn ncols(&self) -> Size<'ncols>

Returns the number of columns of the matrix.

pub fn into_inner(self) -> MatRef<'a, E>

Returns the unconstrained matrix.

pub fn read(&self, i: Idx<'nrows, usize>, j: Idx<'ncols, usize>) -> E

Returns the element at position (i, j).

Trait Implementations§

§

impl<E> Clone for MatRef<'_, '_, '_, E>
where E: Entity,

§

fn clone(&self) -> MatRef<'_, '_, '_, E>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<E> Debug for MatRef<'_, '_, '_, E>
where E: Entity,

§

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

Formats the value using the given formatter. Read more
§

impl<'nrows, 'ncols, 'a, E> IntoConst for MatRef<'nrows, 'ncols, 'a, E>
where E: Entity,

§

type Target = MatRef<'nrows, 'ncols, 'a, E>

§

fn into_const(self) -> <MatRef<'nrows, 'ncols, 'a, E> as IntoConst>::Target

§

impl<'nrows, 'ncols, 'a, 'short, E> Reborrow<'short> for MatRef<'nrows, 'ncols, 'a, E>
where E: Entity,

§

type Target = MatRef<'nrows, 'ncols, 'short, E>

§

fn rb( &'short self, ) -> <MatRef<'nrows, 'ncols, 'a, E> as Reborrow<'short>>::Target

§

impl<'nrows, 'ncols, 'a, 'short, E> ReborrowMut<'short> for MatRef<'nrows, 'ncols, 'a, E>
where E: Entity,

§

type Target = MatRef<'nrows, 'ncols, 'short, E>

§

fn rb_mut( &'short mut self, ) -> <MatRef<'nrows, 'ncols, 'a, E> as ReborrowMut<'short>>::Target

§

impl<E> Copy for MatRef<'_, '_, '_, E>
where E: Entity,

Auto Trait Implementations§

§

impl<'nrows, 'ncols, 'a, E> Freeze for MatRef<'nrows, 'ncols, 'a, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<NonNull<<E as Entity>::Unit>>: Freeze,

§

impl<'nrows, 'ncols, 'a, E> RefUnwindSafe for MatRef<'nrows, 'ncols, 'a, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<NonNull<<E as Entity>::Unit>>: RefUnwindSafe, E: RefUnwindSafe,

§

impl<'nrows, 'ncols, 'a, E> Send for MatRef<'nrows, 'ncols, 'a, E>

§

impl<'nrows, 'ncols, 'a, E> Sync for MatRef<'nrows, 'ncols, 'a, E>

§

impl<'nrows, 'ncols, 'a, E> Unpin for MatRef<'nrows, 'ncols, 'a, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<NonNull<<E as Entity>::Unit>>: Unpin,

§

impl<'nrows, 'ncols, 'a, E> UnwindSafe for MatRef<'nrows, 'ncols, 'a, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<NonNull<<E as Entity>::Unit>>: UnwindSafe, E: RefUnwindSafe,

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> IntoEither for T

Source§

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

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

impl<T> UniversalReborrow for T
where T: for<'a> Reborrow<'a>,

§

impl<T> UniversalReborrowMut for T
where T: for<'a> ReborrowMut<'a>,