ALS

Struct ALS 

Source
pub struct ALS<T> { /* private fields */ }

Implementations§

Source§

impl ALS<f64>

Source

pub fn new(n: usize, m: usize, k: usize) -> Self

Constructs a new ALS learner for an initially empty sparse matrix R of size N x M using K features for X and Y.

Source

pub fn add(&mut self, e: RTriplet<f64>) -> Result<Option<f64>, ALSError<f64>>

Adds a value to the sparse matrix R. Will overwrite a previous value if indices coincide.

Source

pub fn reset_x(&mut self)

Resets all entries of X with values uniformly sampled from (0, 1 / sqrt(K)).

Source

pub fn reset_y(&mut self)

Resets all entries of Y with values uniformly sampled from (0, 1 / sqrt(K)).

Source

pub fn reset_r(&mut self)

Clears all entries of R.

Source

pub fn set_regularization(&mut self, lambda: f64)

Sets the regularization factor.

Source

pub fn set_default_iters(&mut self, iters: usize)

Source

pub fn train_for(&mut self, iters: usize)

Trains for a specified amount of iterations.

Source

pub fn train(&mut self)

Trains for the default amount of iterations set for the instance.

Source

pub fn get_row_factors(&self, row: usize) -> Option<&DVector<f64>>

Get the feature vectors of the row

Source

pub fn get_col_factors(&self, col: usize) -> Option<&DVector<f64>>

Source

pub fn get_x(&self) -> &Vec<DVector<f64>>

Source

pub fn get_y(&self) -> &Vec<DVector<f64>>

Source

pub fn cost(&mut self) -> f64

Computes the cost function between X^T x Y and R.

Source

pub fn predict_r_val(&self, n: usize, m: usize) -> f64

Predicts the value of R at some index.

Auto Trait Implementations§

§

impl<T> Freeze for ALS<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ALS<T>
where T: RefUnwindSafe,

§

impl<T> Send for ALS<T>
where T: Send,

§

impl<T> Sync for ALS<T>
where T: Sync,

§

impl<T> Unpin for ALS<T>
where T: Unpin,

§

impl<T> UnwindSafe for ALS<T>
where 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> 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
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> 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 = 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.
Source§

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

Source§

fn vzip(self) -> V