Skip to main content

Fast evaluation of multivariate normal distribution

Project description

Fast evaluation of multivariate normal distributions

This package provides a fast way to evaluate the pdf and cdf of a standardized multivariate normal distribution. Currently, it only contains code for the bivariate normal distribution.

The implementation in this package is based on the following references:

  1. Drezner, Zvi, and George O. Wesolowsky. "On the computation of the bivariate normal integral." Journal of Statistical Computation and Simulation 35.1-2 (1990): 101-107.
  2. Genz, Alan, and Frank Bretz. "Computation of multivariate normal and t probabilities." Lecture Notes in Statistics 195 (2009)

Simply put, the method comes down to an interpolation specifically tailored to the multivariate normal distribution. Although it is an approximation, the method is near to exact and fast. The implementation in Scipy is based on the same methodology, see here and [here](https://github.com/scipy/scipy/blob/v1.13.0/scipy/stats/_qmvnt.py.

With scalar input, the speed is comparable to the Scipy implementation. The Scipy implemantation, however, is slow for vector valued input. This packages containes a vectorized implementation which is signficantly faster albeit still slower than a native C implementation such as the one in the approxcdf package. The advantage of this package is that it is pure Python and does not require any (build) dependencies.

Rough findings for speed improvements compared to the Scipy implementation.

Module Correlation Speed improvement single Speed improvement vectorized
fastnorm abs < 0.925 >1000 x faster than Scipy 10 x faster than Scipy
approxcdf abs < 0.925 >1000 x faster than Scipy 10 x faster than Scipy
fastnorm abs > 0.925 >1000 x faster than Scipy 3 x faster than Scipy
approxcdf abs > 0.925 >1000 x faster than Scipy 10 x faster than Scipy

These finds are based on an average of 100 runs and can be reproduced by running the example.py script.

Basic example

import fastnorm as fn
correl = 0.5

x=[1,1]
fn.bivar_norm_pdf(x, correl)
fn.bivar_norm_cdf(x, correl)

x=[[1,1],[2,2]]
fn.bivar_norm_pdf(x, correl)
fn.bivar_norm_cdf(x, correl)

Installation

To install from PyPI:

pip install fastnorm

To install the latest development version from github:

pip install git+https://github.com/mvds314/fastnorm.git

Development

For development purposes, clone the repo:

git clone https://github.com/mvds314/fastnorm.git

Then navigate to the folder containing setup.py and run

pip install -e .

to install the package in edit mode.

Run unittests with pytest.

Roadmap

  • Add support for the trivariate and quadrivariate normal distribution.
  • Add support for the higher dimensional normal distribution.
  • Maybe extend to the multivariate t-distribution.

Related software

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastnorm-25.11.1.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastnorm-25.11.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file fastnorm-25.11.1.tar.gz.

File metadata

  • Download URL: fastnorm-25.11.1.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for fastnorm-25.11.1.tar.gz
Algorithm Hash digest
SHA256 68ee53a565a937c9402dc132b52ff984ff75ff0fc08ab098530a2785c6ad9037
MD5 b4db600dd60bba21cb252425070a4bcc
BLAKE2b-256 b9c6a1ca92c2bbf8d6f56f9fe166a26aa9273dd65bb6a0d23729f3e1b57443aa

See more details on using hashes here.

File details

Details for the file fastnorm-25.11.1-py3-none-any.whl.

File metadata

  • Download URL: fastnorm-25.11.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for fastnorm-25.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f378e768cd55fdeb4d92f622b9476a92806605ad97054d68a68d9eb9dca90e9
MD5 e9d74d388635c32c7aafb0f8341e9a09
BLAKE2b-256 67d023e71c16fc5fcb4d05bde62701f025206ee1c7516b10e4db6c3bf1c30fde

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page