pub struct CanonicalCorrelationAnalysis {
pub n_components: Option<usize>,
pub scale: bool,
pub reg_param: f64,
pub max_iter: usize,
pub tol: f64,
}Expand description
Canonical Correlation Analysis
CCA finds linear combinations of variables in two datasets that have maximum correlation. This is useful for exploring relationships between two multivariate datasets.
Fields§
§n_components: Option<usize>Number of canonical components to compute
scale: boolWhether to scale the data
reg_param: f64Regularization parameter for numerical stability
max_iter: usizeMaximum number of iterations for iterative algorithms
tol: f64Convergence tolerance
Implementations§
Source§impl CanonicalCorrelationAnalysis
impl CanonicalCorrelationAnalysis
Sourcepub fn with_n_components(self, ncomponents: usize) -> Self
pub fn with_n_components(self, ncomponents: usize) -> Self
Set number of components to compute
Sourcepub fn with_scale(self, scale: bool) -> Self
pub fn with_scale(self, scale: bool) -> Self
Set whether to scale the data
Sourcepub fn with_reg_param(self, regparam: f64) -> Self
pub fn with_reg_param(self, regparam: f64) -> Self
Set regularization parameter
Sourcepub fn with_max_iter(self, maxiter: usize) -> Self
pub fn with_max_iter(self, maxiter: usize) -> Self
Set maximum iterations
Sourcepub fn with_tolerance(self, tol: f64) -> Self
pub fn with_tolerance(self, tol: f64) -> Self
Set convergence tolerance
Sourcepub fn fit(
&self,
x: ArrayView2<'_, f64>,
y: ArrayView2<'_, f64>,
) -> Result<CCAResult>
pub fn fit( &self, x: ArrayView2<'_, f64>, y: ArrayView2<'_, f64>, ) -> Result<CCAResult>
Fit the CCA model
Sourcepub fn transform(
&self,
x: ArrayView2<'_, f64>,
y: ArrayView2<'_, f64>,
result: &CCAResult,
) -> Result<(Array2<f64>, Array2<f64>)>
pub fn transform( &self, x: ArrayView2<'_, f64>, y: ArrayView2<'_, f64>, result: &CCAResult, ) -> Result<(Array2<f64>, Array2<f64>)>
Transform new data using fitted CCA model
Sourcepub fn score(
&self,
x: ArrayView2<'_, f64>,
y: ArrayView2<'_, f64>,
result: &CCAResult,
) -> Result<Array1<f64>>
pub fn score( &self, x: ArrayView2<'_, f64>, y: ArrayView2<'_, f64>, result: &CCAResult, ) -> Result<Array1<f64>>
Compute canonical correlations for new data
Trait Implementations§
Source§impl Clone for CanonicalCorrelationAnalysis
impl Clone for CanonicalCorrelationAnalysis
Source§fn clone(&self) -> CanonicalCorrelationAnalysis
fn clone(&self) -> CanonicalCorrelationAnalysis
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for CanonicalCorrelationAnalysis
impl Debug for CanonicalCorrelationAnalysis
Auto Trait Implementations§
impl Freeze for CanonicalCorrelationAnalysis
impl RefUnwindSafe for CanonicalCorrelationAnalysis
impl Send for CanonicalCorrelationAnalysis
impl Sync for CanonicalCorrelationAnalysis
impl Unpin for CanonicalCorrelationAnalysis
impl UnsafeUnpin for CanonicalCorrelationAnalysis
impl UnwindSafe for CanonicalCorrelationAnalysis
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.