Struct RandomProjectionParams

pub struct RandomProjectionParams<Proj: ProjectionMethod, R: Rng + Clone>(/* private fields */);

Random projection hyperparameters

The main hyperparameter of random projections is the dimension of the embedding. This dimension is usually determined by the desired precision (or distortion) eps, using the Johnson-Lindenstrauss Lemma. However, this lemma makes a very conservative estimate of the required dimension, and does not leverage the structure of the data, therefore it is also possible to manually specify the dimension of the embedding.

As this algorithm is randomized, it also accepts an Rng as parameter, to be used to sample coordinate of the projection matrix.

Implementations

impl<Proj: ProjectionMethod, R: Rng + Clone> RandomProjectionParams<Proj, R>

pub fn target_dim(self, dim: usize) -> Self

Set the dimension of output of the embedding.

Setting the target dimension with this function discards the precision parameter if it had been set previously.

pub fn eps(self, eps: f64) -> Self

Set the precision parameter (distortion, eps) of the embedding.

Setting eps with this function discards the target dimension parameter if it had been set previously.

pub fn with_rng<R2: Rng + Clone>( self, rng: R2, ) -> RandomProjectionParams<Proj, R2>

Specify the random number generator to use to generate the projection matrix.

Trait Implementations

impl<Proj: ProjectionMethod, R: Rng + Clone> ParamGuard for RandomProjectionParams<Proj, R>

type Checked = RandomProjectionValidParams<Proj, R>

The checked hyperparameters

type Error = ReductionError

Error type resulting from failed hyperparameter checking

fn check_ref(&self) -> Result<&Self::Checked, Self::Error>

Checks the hyperparameters and returns a reference to the checked hyperparameters if successful

fn check(self) -> Result<Self::Checked, Self::Error>

Checks the hyperparameters and returns the checked hyperparameters if successful

fn check_unwrap(self) -> Self::Checked

where Self: Sized,

Calls check() and unwraps the result