Skip to main content

DenseInput

Struct DenseInput 

Source
pub struct DenseInput<'a, F: BixverseFloat> { /* private fields */ }
Expand description

Dense, non-negative V wrapped behind the NMF trait. Validates non-negativity and finiteness once at construction.

Implementations§

Source§

impl<'a, F: BixverseFloat> DenseInput<'a, F>

Source

pub fn new(v: MatRef<'a, F>) -> Result<Self, MethodsErrors>

Construct a DenseInput from a borrowed matrix.

Validates that all entries are finite and non-negative, then computes ||V||_F^2.

§Params
  • v - The input matrix to factorise.
§Returns

A DenseInput wrapping v.

Trait Implementations§

Source§

impl<'a, F: Debug + BixverseFloat> Debug for DenseInput<'a, F>

Source§

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

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

impl<F: BixverseFloat> NmfInput<F> for DenseInput<'_, F>

NmfInput trait implementation for DenseInput

Source§

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

Returns the shape Read more
Source§

fn sq_frob(&self) -> F

The squared Frobenius norm ||V||_F^2, Read more
Source§

fn wt_v(&self, w: MatRef<'_, F>, out: &mut Mat<F>)

Compute W^T V. Read more
Source§

fn v_ht(&self, h: MatRef<'_, F>, out: &mut Mat<F>)

Gram matrix W^T W. Read more
Source§

fn top_k_svd(&self, k: usize) -> Result<SvdResults<F>, MethodsErrors>

Top-k truncated SVD of V. Read more

Auto Trait Implementations§

§

impl<'a, F> Freeze for DenseInput<'a, F>
where Mat<Ref<'a, F>>: Freeze, F: Freeze,

§

impl<'a, F> RefUnwindSafe for DenseInput<'a, F>
where Mat<Ref<'a, F>>: RefUnwindSafe, F: RefUnwindSafe,

§

impl<'a, F> Send for DenseInput<'a, F>
where Mat<Ref<'a, F>>: Send,

§

impl<'a, F> Sync for DenseInput<'a, F>
where Mat<Ref<'a, F>>: Sync,

§

impl<'a, F> Unpin for DenseInput<'a, F>
where Mat<Ref<'a, F>>: Unpin, F: Unpin,

§

impl<'a, F> UnsafeUnpin for DenseInput<'a, F>
where Mat<Ref<'a, F>>: UnsafeUnpin, F: UnsafeUnpin,

§

impl<'a, F> UnwindSafe for DenseInput<'a, F>
where Mat<Ref<'a, F>>: UnwindSafe, F: 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> 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, 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