Skip to main content

Factor

Struct Factor 

Source
pub struct Factor { /* private fields */ }
Expand description

A principal-axis factor analysis awaiting estimation.

Construct from a correlation matrix with Factor::from_corr or from a raw nobs × nvar data matrix with Factor::from_data (which standardises the columns into a Pearson correlation matrix), set the number of factors, then call Factor::fit.

Implementations§

Source§

impl Factor

Source

pub fn from_corr(corr: Array2<f64>, n_factor: usize, smc: bool) -> Self

A factor analysis on a correlation (or covariance) matrix corr.

n_factor is the number of factors to extract; smc selects squared multiple correlations as the initial communality estimate (matching the reference default smc=True).

Source

pub fn from_data(data: &Array2<f64>, n_factor: usize, smc: bool) -> Self

A factor analysis on a raw nobs × nvar data matrix. The columns are turned into a Pearson correlation matrix (population covariance scaled by the standard deviations) before estimation.

Source

pub fn fit(&self, maxiter: usize, tol: f64) -> Result<FactorResults>

Estimate the factor model with the iterative principal-axis method.

maxiter bounds the number of communality-update iterations and tol is the convergence threshold on the change in communalities (the reference requires 0 < tol <= 0.01).

Trait Implementations§

Source§

impl Clone for Factor

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 Debug for Factor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.