pub struct CorrelationBuilder<F> { /* private fields */ }Expand description
Builder pattern for correlation analysis
Implementations§
Source§impl<F> CorrelationBuilder<F>
impl<F> CorrelationBuilder<F>
Sourcepub fn method(self, method: CorrelationMethod) -> Self
pub fn method(self, method: CorrelationMethod) -> Self
Set correlation method
Sourcepub fn min_periods(self, periods: usize) -> Self
pub fn min_periods(self, periods: usize) -> Self
Set minimum number of periods for valid correlation
Sourcepub fn confidence_level(self, level: f64) -> Self
pub fn confidence_level(self, level: f64) -> Self
Set confidence level for p-values and confidence intervals
Sourcepub fn with_metadata(self) -> Self
pub fn with_metadata(self) -> Self
Include metadata in results
Sourcepub fn compute<'a>(
&self,
x: ArrayView1<'a, F>,
y: ArrayView1<'a, F>,
) -> StatsResult<StandardizedResult<CorrelationResult<F>>>
pub fn compute<'a>( &self, x: ArrayView1<'a, F>, y: ArrayView1<'a, F>, ) -> StatsResult<StandardizedResult<CorrelationResult<F>>>
Compute correlation between two variables
Sourcepub fn compute_matrix(
&self,
data: ArrayView2<'_, F>,
) -> StatsResult<StandardizedResult<Array2<F>>>
pub fn compute_matrix( &self, data: ArrayView2<'_, F>, ) -> StatsResult<StandardizedResult<Array2<F>>>
Compute correlation matrix for multiple variables
Trait Implementations§
Auto Trait Implementations§
impl<F> Freeze for CorrelationBuilder<F>
impl<F> RefUnwindSafe for CorrelationBuilder<F>where
F: RefUnwindSafe,
impl<F> Send for CorrelationBuilder<F>where
F: Send,
impl<F> Sync for CorrelationBuilder<F>where
F: Sync,
impl<F> Unpin for CorrelationBuilder<F>where
F: Unpin,
impl<F> UnwindSafe for CorrelationBuilder<F>where
F: UnwindSafe,
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
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
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.