Skip to main content

NamedMatrix

bixverse_core::core::mat_struct

Struct NamedMatrix 

Source 
pub struct NamedMatrix<'a, T> {
    pub col_names: BTreeMap<String, usize>,
    pub row_names: BTreeMap<String, usize>,
    pub values: MatRef<'a, T>,
}
Expand description

Structure to store named matrices

Fields§

§col_names: BTreeMap<String, usize>

A BTreeMap representing the column names and the col indices

§row_names: BTreeMap<String, usize>

A BTreeMap representing the row names and the row indices

§values: MatRef<'a, T>

A faer matrix reference representing the matrix values.

Implementations§

Source§

impl<'a, T> NamedMatrix<'a, T>
where T: BixverseFloat,

Source

pub fn get_sub_mat( &self, rows_to_select: Option<&[&str]>, cols_to_select: Option<&[&str]>, ) -> Option<Mat<T>>

Return a submatrix based on the row names and columns to select.

If no rows or columns are specified, returns the full matrix. If empty slices are provided, returns None.

§Params
  • rows_to_select - Names of the row features
  • cols_to_select - Names of the column features
§Returns

The faer Matrix with the values from the rows and columns.

Source

pub fn get_full_mat(&self) -> Mat<T>

Convenience method to get the full matrix

§Returns

Faer matrix representing the full data.

Source

pub fn get_rows(&self, rows_to_select: &[&str]) -> Option<Mat<T>>

Convenience method to get submatrix with only row selection

§Params
  • rows_to_select - Names of the row features
§Returns

Faer matrix with the selected rows.

Source

pub fn get_cols(&self, cols_to_select: &[&str]) -> Option<Mat<T>>

Convenience method to get submatrix with only column selection

§Params
  • cols_to_select - Names of the column features
§Returns

Faer matrix with the selected columns.

Source

pub fn get_col_names_refs(&self) -> Vec<&String>

Get column names as references (for temporary use within same scope)

§Returns

The column names as a reference

Source

pub fn get_row_names_refs(&self) -> Vec<&String>

Get row names as references (for temporary use within same scope)

§Returns

The row names as a reference

Source

pub fn get_row_indices(&self, rows_to_select: Option<&[&str]>) -> Vec<usize>

Get the row indices based on names

§Params
  • rows_to_select - Names of the row features
Source

pub fn get_col_indices(&self, cols_to_select: Option<&[&str]>) -> Vec<usize>

Get the col indices based on names

§Params
  • rows_to_select - Names of the row features

Trait Implementations§

Source§

impl<'a, T: Clone> Clone for NamedMatrix<'a, T>

Source§

fn clone(&self) -> Self

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<'a, T: Debug> Debug for NamedMatrix<'a, T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: Freeze,

§

impl<'a, T> RefUnwindSafe for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: RefUnwindSafe,

§

impl<'a, T> Send for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: Send,

§

impl<'a, T> Sync for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: Sync,

§

impl<'a, T> Unpin for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: Unpin,

§

impl<'a, T> UnsafeUnpin for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: UnsafeUnpin,

§

impl<'a, T> UnwindSafe for NamedMatrix<'a, T>
where Mat<Ref<'a, T>>: 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

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

Source§

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

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> DistributionExt for T
where T: ?Sized,

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

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

Source§

fn vzip(self) -> V