Package: CholWishart 1.1.4

Geoffrey Thompson

CholWishart: Cholesky Decomposition of the Wishart Distribution

Sampling from the Cholesky factorization of a Wishart random variable, sampling from the inverse Wishart distribution, sampling from the Cholesky factorization of an inverse Wishart random variable, sampling from the pseudo Wishart distribution, sampling from the generalized inverse Wishart distribution, computing densities for the Wishart and inverse Wishart distributions, and computing the multivariate gamma and digamma functions. Provides a header file so the C functions can be called directly from other programs.

Authors:Geoffrey Thompson [aut, cre], R Core Team [ctb]

CholWishart_1.1.4.tar.gz
CholWishart_1.1.4.tar.gz(r-4.5-noble)CholWishart_1.1.4.tar.gz(r-4.4-noble)
CholWishart_1.1.4.tgz(r-4.4-emscripten)CholWishart_1.1.4.tgz(r-4.3-emscripten)
CholWishart.pdf |CholWishart.html✨
CholWishart/json (API)
NEWS

# Install 'CholWishart' in R:
install.packages('CholWishart', repos = 'https://cloud.r-project.org')

Bug tracker:https://github.com/gzt/cholwishart/issues0 issues

Pkgdown site:https://gzt.github.io

Uses libs:
  • openblas– Optimized BLAS

On CRAN:

Conda:

openblas

4.59 score 1 stars 13 packages 854 downloads 10 exports 0 dependencies

Last updated 6 months agofrom:832eddd606. Checks:3 OK. Indexed: no.

TargetResultLatest binary
Doc / VignettesOKMar 18 2025
R-4.5-linux-x86_64OKMar 18 2025
R-4.4-linux-x86_64OKMar 18 2025

Exports:dInvWishartdWishartlmvgammamvdigammamvgammarCholWishartrGenInvWishartrInvCholWishartrInvWishartrPseudoWishart

Dependencies:

Some Distributions Related to the Wishart

Geoffrey Thompson

Rendered fromwishart.Rmdusingknitr::rmarkdownon Mar 18 2025.

Last update: 2019-01-07
Started: 2018-02-26

Citation

To cite package ‘CholWishart’ in publications use:

Thompson G (2024). CholWishart: Cholesky Decomposition of the Wishart Distribution. R package version 1.1.4, https://CRAN.R-project.org/package=CholWishart.

Corresponding BibTeX entry: 

  @Manual{,
    title = {CholWishart: Cholesky Decomposition of the Wishart
      Distribution},
    author = {Geoffrey Thompson},
    year = {2024},
    note = {R package version 1.1.4},
    url = {https://CRAN.R-project.org/package=CholWishart},
  }

Readme and manuals

minimal R version CRAN_Status_Badge packageversion

Last-changedate

CholWishart

The most common use for this package is likely fast sampling from the inverse Wishart or use of the multivariate gamma or digamma functions. This is a package for fast computation of various functions related to the Wishart distribution, such as sampling from the Cholesky factorization of the Wishart, sampling from the inverse Wishart, sampling from the Cholesky factorization of the inverse Wishart, sampling from the pseudo Wishart, computing densities for the Wishart and inverse Wishart, and computing a few auxiliary functions such as the multivariate gamma and digamma functions. Many of these functions are written in C to maximize efficiency.

The output of the sampling functions is in the same format as the output of stats::rWishart().

The main idea: sampling for multivariate or matrix variate statistics often makes use of distributions related to the Wishart. There are implementations in a few packages but they are often in R and much slower than the basic stats::rWishart() or there is a lot of associated overhead in the package. Here, then, is a small package with some of those distributions and related functions. As the name suggests, the initial purpose was sampling from the Cholesky factorization of a Wishart distribution.

Usage

The package offers the following distributions:

  • The inverse Wishart:
rInvWishart(n = 1,df = 5,Sigma = diag(4)))
  • The Cholesky decomposition of the inverse Wishart:
rInvCholWishart(n = 1,df = 5,Sigma = diag(4)))
  • The Cholesky decomposition of the Wishart
rCholWishart(n = 1,df = 5,Sigma = diag(4)))
  • The pseudo Wishart and its pseudo-inverse, the generalized inverse Wishart (df less than the dimension of Sigma minus 1):
rPseudoWishart(n = 1,df = 3,Sigma = diag(5)))
rGenInvWishart(n = 1,df = 3,Sigma = diag(5)))
  • The package also offers density functions for the Wishart and inverse Wishart distributions:
dInvWishart(x = diag(4), df = 5, Sigma = diag(4), log = TRUE)
dWishart(x = diag(4), df = 5, Sigma = diag(4), log = TRUE)

In addition to this, the package offers the multivariate gamma function and multivariate digamma function, the multivariate counterparts of the gamma and digamma (derivative of the log of the gamma) functions.

mvgamma(x = 5, p = 3)
mvdigamma(x = 5, p = 3)

I suspect the most useful functions for most people will be the mvgamma and rInvWishart functions.

Installation

Now available on CRAN, install it at:

install.packages('CholWishart')

Install the latest development version at:

# install.packages('devtools')
devtools::install_github("gzt/CholWishart")

Calling from other packages

The header inst/install/CholWishart.h is available so that the exported functions can be called in C from other packages.

Contributing

Please note that the ‘CholWishart’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.