MuGen
Multitrait genetics
Functions
Mahalanobis distance functions

Functions

virtual double MVnorm::mhl (const MVnorm *x, const SigmaI &SigI)
 Mahalanobis distance to a vector. More...
 
virtual double MVnorm::mhl (const MVnorm *x, const SigmaI &SigI) const
 Mahalanobis distance to a vector. More...
 
virtual double MVnorm::mhl (const gsl_vector *x, const SigmaI &SigI)
 Mahalanobis distance to a vector. More...
 
virtual double MVnorm::mhl (const gsl_vector *x, const SigmaI &SigI) const
 Mahalanobis distance to a vector. More...
 
virtual double MVnorm::mhl (const SigmaI &SigI)
 Mahalanobis distance to zero. More...
 
virtual double MVnorm::mhl (const SigmaI &SigI) const
 Mahalanobis distance to zero. More...
 

Detailed Description

Overloaded functions to calculate the Mahalanobis distance of the vector of location parameters stored in the class to another vector or to zero.

Function Documentation

◆ mhl() [1/6]

double MVnorm::mhl ( const gsl_vector *  x,
const SigmaI SigI 
)
virtual

Mahalanobis distance to a vector.

Calculates the Mahalanobis distance between the vector stored in the class and the provided GSL vector.

Parameters
[in]MVnorm&vector to calculate the distance from
[in]SigmaI&inverse covariance matrix for scaling
Returns
the distance value of type double.

◆ mhl() [2/6]

double MVnorm::mhl ( const gsl_vector *  x,
const SigmaI SigI 
) const
virtual

Mahalanobis distance to a vector.

Calculates the Mahalanobis distance between the vector stored in the class and the provided GSL vector. The const version of the above function.

Parameters
[in]MVnorm&vector to calculate the distance from
[in]SigmaI&inverse covariance matrix for scaling
Returns
the distance value of type double.

◆ mhl() [3/6]

double MVnorm::mhl ( const MVnorm x,
const SigmaI SigI 
)
virtual

Mahalanobis distance to a vector.

Calculates the Mahalanobis distance between the vector stored in the class and the provided vector of class MVnorm.

Parameters
[in]MVnorm&vector to calculate the distance from
[in]SigmaI&inverse covariance matrix for scaling
Returns
the distance value of type double.

◆ mhl() [4/6]

double MVnorm::mhl ( const MVnorm x,
const SigmaI SigI 
) const
virtual

Mahalanobis distance to a vector.

Calculates the Mahalanobis distance between the vector stored in the class and the provided vector of class MVnorm. The const version of the above function.

Parameters
[in]MVnorm&vector to calculate the distance from
[in]SigmaI&inverse covariance matrix for scaling
Returns
the distance value of type double.

◆ mhl() [5/6]

double MVnorm::mhl ( const SigmaI SigI)
virtual

Mahalanobis distance to zero.

Calculates the Mahalanobis distance between the vector stored in the class zero.

Parameters
[in]SigmaI&inverse covariance matrix for scaling
Returns
the distance value of type double.

◆ mhl() [6/6]

double MVnorm::mhl ( const SigmaI SigI) const
virtual

Mahalanobis distance to zero.

Calculates the Mahalanobis distance between the vector stored in the class zero. The const version of the above function.

Parameters
[in]SigmaI&inverse covariance matrix for scaling
Returns
the distance value of type double.