Struct petal_decomposition::RandomizedPcaBuilder

pub struct RandomizedPcaBuilder<R> { /* private fields */ }

Builder for RandomizedPca.

Examples

use petal_decomposition::RandomizedPcaBuilder;

let x = ndarray::arr2(&[[0_f64, 0_f64], [1_f64, 1_f64]]);
let mut pca = RandomizedPcaBuilder::new(1).build();
pca.fit(&x);

Implementations

impl RandomizedPcaBuilder<Pcg>

pub fn new(n_components: usize) -> Self

Sets the number of components for PCA.

The random matrix for randomized SVD is created from a PCG random number generator (the XSL 128/64 (MCG) variant on a 64-bit CPU and the XSH RR 64/32 (LCG) variant on a 32-bit CPU), initialized with a randomly-generated seed.

pub fn seed(self, seed: u128) -> Self

Initialized the PCG random number genernator with the given seed.

Examples

use petal_decomposition::RandomizedPcaBuilder;

let x = ndarray::arr2(&[[0_f64, 0_f64], [1_f64, 1_f64]]);
let mut pca = RandomizedPcaBuilder::new(1).seed(1234567891011121314).build();
pca.fit(&x);

pub fn centering(self, centering: bool) -> Self

Indicates whether or not to perform mean-centering on input data. It is enabled by default. If the inputs are already centered, set centering to false. Note Pca::mean() will return an Array1 of 0’s if centering is false.

Examples

use petal_decomposition::RandomizedPcaBuilder;

let x = ndarray::arr2(&[[0_f64, 0_f64], [1_f64, 1_f64]]);
let mut pca = RandomizedPcaBuilder::new(1).centering(false).build();
pca.fit(&x);

impl<R: Rng> RandomizedPcaBuilder<R>

pub fn with_rng(rng: R, n_components: usize) -> Self

Sets the number of components and random number generator for PCA.

The random number generator is used to create a random matrix for randomized SVD.

Examples

use petal_decomposition::RandomizedPcaBuilder;
use rand_pcg::Pcg64;

let x = ndarray::arr2(&[[0_f64, 0_f64], [1_f64, 1_f64]]);
let rng = Pcg64::new(0xcafef00dd15ea5e5, 0xa02bdbf7bb3c0a7ac28fa16a64abf96);
let mut pca = RandomizedPcaBuilder::with_rng(rng, 1).build();
pca.fit(&x);

pub fn build<A: Scalar>(self) -> RandomizedPca<A, R>

Creates an instance of RandomizedPca.