Struct PpcaParams

Source

pub struct PpcaParams {
    pub n_pcs: usize,
    pub max_iter: usize,
    pub tol: f64,
    pub seed: u64,
    pub centre: bool,
    pub scale: bool,
}

Expand description

Parameters for probabilistic PCA.

Fields§

§n_pcs: usize

Number of principal components

§max_iter: usize

Maximum number of EM iterations

§tol: f64

Relative change in the objective below which EM stops

§seed: u64

Seed for the random initial loadings

§centre: bool

Subtract the observed column means first

§scale: bool

Divide by the observed column SD first (pcaMethods’ "uv")

Implementations§

Source §

impl PpcaParams

Source

pub fn new( n_pcs: usize, max_iter: usize, tol: f64, seed: u64, centre: bool, scale: bool, ) -> Self

Generate new PPCA parameters.

§Params

n_pcs - Number of principal components
max_iter - Maximum number of EM iterations
tol - Relative change in the objective below which EM stops
seed - Seed for the random initial loadings
centre - Subtract the observed column means first
scale - Divide by the observed column SD first

§Returns

The PpcaParams.

Trait Implementations§

Source §

impl Clone for PpcaParams

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 Copy for PpcaParams

Source §

impl Debug for PpcaParams

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for PpcaParams

Source §

fn default() -> Self

pcaMethods’ defaults.

Auto Trait Implementations§

§

impl UnwindSafe for PpcaParams

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