version 3.1.0

Author: kthohr

.readthedocs.requirements.txt

@@ -1,3 +1,3 @@
-sphinx == 1.8.1
-breathe
-sphinxcontrib-katex
+sphinx == 2.4.4
+breathe == 4.11.0
+sphinxcontrib-katex == 0.6.0

NOTICE.txt

@@ -1,4 +1,4 @@
 StatsLib: A C++ Library of Statistical Distribution Functions
-Copyright 2011-2019 Keith O'Hara
+Copyright 2011-2020 Keith O'Hara
 
 This product includes software developed by Keith O'Hara (http://www.kthohr.com)

README.md

@@ -2,7 +2,7 @@
 
 
 
-StatsLib is a templated C++ library of statistical distribution functions featuring unique compile-time computing capabilities and seamless integration with several popular linear algebra libraries.
+StatsLib is a templated C++ library of statistical distribution functions, featuring unique compile-time computing capabilities and seamless integration with several popular linear algebra libraries.
 
 Features:
 * A header-only library of probability density functions, cumulative distribution functions, quantile functions, and random sampling methods.
@@ -77,7 +77,7 @@ The following options should be declared **before** including the StatsLib heade
 #define STATS_GO_INLINE
 ```
 
-* OpenMP functionality is enabled by default if the `_OPENMP` macro is detected (e.g., by invoking `-fopenmp` with a GCC or Clang compiler). To explicitly enable OpenMP features use:
+* OpenMP functionality is enabled by default if the `_OPENMP` macro is detected (e.g., by invoking `-fopenmp` with GCC or Clang). To explicitly enable OpenMP features use:
 ```cpp
 #define STATS_USE_OPENMP
 ```
@@ -131,7 +131,7 @@ All of these functions have matrix-based equivalents using Armadillo, Blaze, and
 arma::mat norm_pdf_vals = stats::dnorm(arma::ones(10,20),1.0,2.0);
 ```
 
-* The randomization functions (`r*`) can output random matrices of arbitrary size. For example,</li>
+* The randomization functions (`r*`) can output random matrices of arbitrary size. For example, For example, the following code will generate a 100-by-50 matrix of iid draws from a Gamma(3,2) distribution:</li>
 
 ```cpp
 // Armadillo:
@@ -141,13 +141,12 @@ blaze::DynamicMatrix<double> gamma_rvs = stats::rgamma<blaze::DynamicMatrix<doub
 // Eigen:
 Eigen::MatrixXd gamma_rvs = stats::rgamma<Eigen::MatrixXd>(100,50,3.0,2.0);
 ```
-&nbsp; &nbsp; &nbsp; &nbsp; will generate a 100-by-50 matrix of iid draws from a Gamma(3,2) distribution.
 
 * All matrix-based operations are parallelizable with OpenMP. For GCC and Clang compilers, simply include the `-fopenmp` option during compilation.
 
-### Seeding
+### Seeding Values
 
-Random number seeding is available in two formats: seed values and random number engines.
+Random number seeding is available in two forms: seed values and random number engines.
 
 * Seed values are passed as unsigned integers. For example, to generate a draw from a normal distribution N(1,2) with seed value 1776:
 ``` cpp
@@ -188,7 +187,7 @@ arma::mat beta_cdf_vals = stats::pbeta(beta_rvs,3.0,2.0);
 
 StatsLib is designed to operate equally well as a compile-time computation engine. Compile-time computation allows the compiler to replace function calls (e.g., `dnorm(0,0,1)`) with static values in the source code. That is, functions are evaluated during the compilation process, rather than at run-time. This capability is made possible due to the templated `constexpr` design of the library and can be verified by inspecting the assembly code generated by the compiler. 
 
-The compile-time features are enabled using the `constexpr` specifier. The example below computes the pdf, cdf, and quantile function of the Laplace distribution:
+The compile-time features are enabled using the `constexpr` specifier. The example below computes the pdf, cdf, and quantile function of the Laplace distribution.
 ```cpp
 #include "stats.hpp"
 

binder/environment.yml

@@ -1,8 +1,7 @@
 # For use with Binder
 name: statslib
 channels:
-  - QuantStack
   - conda-forge
 dependencies:
-  - xeus-cling=0.4.7
+  - xeus-cling=0.8.1
   - notebook

docs/Doxyfile

@@ -17,6 +17,7 @@ MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = YES
 PREDEFINED             = "statslib_constexpr=constexpr" \
                          "statslib_inline=inline" \
+                         "STATS_ENABLE_INTERNAL_VEC_FEATURES" \
                          "STATS_ENABLE_STDVEC_WRAPPERS" \
                          "STATS_ENABLE_ARMA_WRAPPERS" \
                          "STATS_ENABLE_BLAZE_WRAPPERS" \

docs/source/api/bernoulli.rst

@@ -1,4 +1,4 @@
-.. Copyright (c) 2011--2018 Keith O'Hara
+.. Copyright (c) 2011-2020 Keith O'Hara
 
    Distributed under the terms of the Apache License, Version 2.0.
 
@@ -7,14 +7,22 @@
 Bernoulli Distribution
 ======================
 
+**Table of contents**
+
+.. contents:: :local:
+
+----
+
+Density Function
+----------------
+
 The density function of the Bernoulli distribution:
 
 .. math::
 
    f(x; p) = p^x (1-p)^{1-x} \times \mathbf{1}[x \in \{0,1\}]
 
-PDF
----
+Methods for scalar input, as well as for vector/matrix input, are listed below.
 
 Scalar Input
 ~~~~~~~~~~~~
@@ -26,32 +34,46 @@ Scalar Input
 Vector/Matrix Input
 ~~~~~~~~~~~~~~~~~~~
 
-1. STL Containers
+STL Containers
+______________
 
 .. _dbern-func-ref2:
 .. doxygenfunction:: dbern(const std::vector<eT>&, const T1, const bool)
    :project: statslib
 
-2. Armadillo
+Armadillo
+_________
 
 .. _dbern-func-ref3:
 .. doxygenfunction:: dbern(const ArmaMat<eT>&, const T1, const bool)
    :project: statslib
 
-3. Blaze
+Blaze
+_____
 
 .. _dbern-func-ref4:
 .. doxygenfunction:: dbern(const BlazeMat<eT, To>&, const T1, const bool)
    :project: statslib
 
-4. Eigen
+Eigen
+_____
 
 .. _dbern-func-ref5:
 .. doxygenfunction:: dbern(const EigenMat<eT, iTr, iTc>&, const T1, const bool)
    :project: statslib
 
-CDF
----
+----
+
+Cumulative Distribution Function
+--------------------------------
+
+The cumulative distribution function of the Bernoulli distribution:
+
+.. math::
+
+   F(x; p) = \sum_{z \leq x} f(z; p) = \begin{cases} 0 & \text{ if } x < 0 \\ 1-p & \text{ if } 0 \leq x < 1 \\ 1 & \text{ if } x \geq 1 \end{cases}
+
+Methods for scalar input, as well as for vector/matrix input, are listed below.
 
 Scalar Input
 ~~~~~~~~~~~~
@@ -63,32 +85,46 @@ Scalar Input
 Vector/Matrix Input
 ~~~~~~~~~~~~~~~~~~~
 
-1. STL Containers
+STL Containers
+______________
 
 .. _pbern-func-ref2:
 .. doxygenfunction:: pbern(const std::vector<eT>&, const T1, const bool)
    :project: statslib
 
-2. Armadillo
+Armadillo
+_________
 
 .. _pbern-func-ref3:
 .. doxygenfunction:: pbern(const ArmaMat<eT>&, const T1, const bool)
    :project: statslib
 
-3. Blaze
+Blaze
+_____
 
 .. _pbern-func-ref4:
 .. doxygenfunction:: pbern(const BlazeMat<eT, To>&, const T1, const bool)
    :project: statslib
 
-4. Eigen
+Eigen
+_____
 
 .. _pbern-func-ref5:
 .. doxygenfunction:: pbern(const EigenMat<eT, iTr, iTc>&, const T1, const bool)
    :project: statslib
 
-Quantile
---------
+----
+
+Quantile Function
+-----------------
+
+The quantile function of the Bernoulli distribution:
+
+.. math::
+
+   q(r; p) = \begin{cases} 0 & \text{ if } r \leq 1 - p \\ 1 & \text{ else } \end{cases}
+
+Methods for scalar input, as well as for vector/matrix input, are listed below.
 
 Scalar Input
 ~~~~~~~~~~~~
@@ -100,33 +136,41 @@ Scalar Input
 Vector/Matrix Input
 ~~~~~~~~~~~~~~~~~~~
 
-1. STL Containers
+STL Containers
+______________
 
 .. _qbern-func-ref2:
 .. doxygenfunction:: qbern(const std::vector<eT>&, const T1)
    :project: statslib
 
-2. Armadillo
+Armadillo
+_________
 
 .. _qbern-func-ref3:
 .. doxygenfunction:: qbern(const ArmaMat<eT>&, const T1)
    :project: statslib
 
-3. Blaze
+Blaze
+_____
 
 .. _qbern-func-ref4:
 .. doxygenfunction:: qbern(const BlazeMat<eT, To>&, const T1)
    :project: statslib
 
-4. Eigen
+Eigen
+_____
 
 .. _qbern-func-ref5:
 .. doxygenfunction:: qbern(const EigenMat<eT, iTr, iTc>&, const T1)
    :project: statslib
 
+----
+
 Random Sampling
 ---------------
 
+Random sampling for the Bernoulli distribution is achieved via the inverse probability integral transform.
+
 Scalar Output
 ~~~~~~~~~~~~~