pub struct OneFactorGaussianCopula { /* private fields */ }Expand description
One-factor Gaussian copula.
Models dependence through a single common factor Z and idiosyncratic terms. For each variable i: X_i = β_i * Z + sqrt(1 - β_i^2) * ε_i where Z, ε_i ~ N(0,1) are independent.
§Bibliography
- Li, D. X. (2000). On default correlation: A copula function approach.
Implementations§
Source§impl OneFactorGaussianCopula
impl OneFactorGaussianCopula
Sourcepub fn correlation(&self, i: usize, j: usize) -> Result<f64>
pub fn correlation(&self, i: usize, j: usize) -> Result<f64>
Get the implied correlation between dimensions i and j.
ρ_ij = β_i * β_j
Sourcepub fn correlation_matrix(&self) -> DMatrix<f64>
pub fn correlation_matrix(&self) -> DMatrix<f64>
Get the correlation matrix implied by the factor loadings.
Trait Implementations§
Source§impl Clone for OneFactorGaussianCopula
impl Clone for OneFactorGaussianCopula
Source§fn clone(&self) -> OneFactorGaussianCopula
fn clone(&self) -> OneFactorGaussianCopula
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 Copula for OneFactorGaussianCopula
impl Copula for OneFactorGaussianCopula
Source§fn cdf(&self, u: &[f64]) -> Result<f64>
fn cdf(&self, u: &[f64]) -> Result<f64>
Evaluate the copula cumulative distribution function (CDF) at point u. Read more
Source§fn pdf(&self, u: &[f64]) -> Result<f64>
fn pdf(&self, u: &[f64]) -> Result<f64>
Evaluate the copula probability density function (PDF) at point u. Read more
Source§fn sample<R: Rng + ?Sized>(&self, n: usize, rng: &mut R) -> Result<DMatrix<f64>>
fn sample<R: Rng + ?Sized>(&self, n: usize, rng: &mut R) -> Result<DMatrix<f64>>
Generate random samples from the copula. Read more
Source§fn conditional_cdf(&self, u: &[f64], given: &[usize]) -> Result<f64>
fn conditional_cdf(&self, u: &[f64], given: &[usize]) -> Result<f64>
Compute the conditional copula CDF given some variables. Read more
Source§fn tail_dependence(&self) -> Result<(f64, f64)>
fn tail_dependence(&self) -> Result<(f64, f64)>
Compute the tail dependence coefficients. Read more
Source§fn has_closed_form(&self) -> (bool, bool)
fn has_closed_form(&self) -> (bool, bool)
Check if the copula has analytical forms for CDF and PDF. Read more
Source§fn family_name(&self) -> &'static str
fn family_name(&self) -> &'static str
Get a string identifier for the copula family.
Auto Trait Implementations§
impl Freeze for OneFactorGaussianCopula
impl RefUnwindSafe for OneFactorGaussianCopula
impl Send for OneFactorGaussianCopula
impl Sync for OneFactorGaussianCopula
impl Unpin for OneFactorGaussianCopula
impl UnsafeUnpin for OneFactorGaussianCopula
impl UnwindSafe for OneFactorGaussianCopula
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> SendAlias for T
impl<T> SendSyncUnwindSafe for Twhere
T: Send + Sync + UnwindSafe + ?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.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.