Skip to main content

CopulaConfig

Struct CopulaConfig 

Source
pub struct CopulaConfig {
    pub copula_type: CopulaType,
    pub theta: f64,
    pub degrees_of_freedom: f64,
}
Expand description

Configuration for copula-based correlation.

Fields§

§copula_type: CopulaType

Type of copula to use

§theta: f64

Correlation parameter (interpretation depends on copula type)

  • Gaussian/Student-t: correlation coefficient (-1 to 1)
  • Clayton: theta > 0 (higher = stronger lower tail dependence)
  • Gumbel: theta >= 1 (higher = stronger upper tail dependence)
  • Frank: theta != 0 (|theta| higher = stronger dependence)
§degrees_of_freedom: f64

Degrees of freedom for Student-t copula (only used if copula_type = StudentT)

Implementations§

Source§

impl CopulaConfig

Source

pub fn gaussian(correlation: f64) -> Self

Create a Gaussian copula configuration.

Source

pub fn clayton(theta: f64) -> Self

Create a Clayton copula configuration.

Source

pub fn gumbel(theta: f64) -> Self

Create a Gumbel copula configuration.

Source

pub fn frank(theta: f64) -> Self

Create a Frank copula configuration.

Source

pub fn student_t(correlation: f64, df: f64) -> Self

Create a Student-t copula configuration.

Source

pub fn validate(&self) -> Result<(), String>

Validate the configuration.

Source

pub fn kendalls_tau(&self) -> f64

Get the implied Kendall’s tau for this copula configuration.

Source

pub fn lower_tail_dependence(&self) -> f64

Get the lower tail dependence coefficient.

Source

pub fn upper_tail_dependence(&self) -> f64

Get the upper tail dependence coefficient.

Trait Implementations§

Source§

impl Clone for CopulaConfig

Source§

fn clone(&self) -> CopulaConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CopulaConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CopulaConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CopulaConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CopulaConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,