Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rileyjmurray committed Sep 3, 2024
1 parent 56117ec commit 380513a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions RandBLAS/util.hh
Original file line number Diff line number Diff line change
Expand Up @@ -333,11 +333,12 @@ void transpose_square(T* A, int64_t n, int64_t lda) {
/// \fn weights_to_cdf(int64_t n, T* w, T error_if_below = -std::numeric_limits<T>::epsilon())
/// @verbatim embed:rst:leading-slashes
/// Checks if all elements of length-:math:`n` array ":math:`w`" are at no smaller than
/// :math:`\ttt{error_if_below}.` If this check passes, then we overwrite
/// :math:`\ttt{error_if_below}.` If this check passes, then we (implicitly) initialize :math:`v := w``
/// and overwrite :math:`w` by
///
/// .. math::
///
/// w_i := \max\{0, w_i\} / \textstyle\sum_{j=1}^n \max\{0, w_j\}.
/// w_i = \frac{\textstyle\sum_{\ell=1}^{i}\max\{0, v_{\ell}\}}{\textstyle\sum_{j=1}^n \max\{0, v_j\}}.
///
/// @endverbatim
/// On exit, \math{w} is a CDF suitable for use with sample_indices_iid.
Expand Down
4 changes: 2 additions & 2 deletions rtd/source/api_reference/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Random sampling from index sets
.. doxygenfunction:: RandBLAS::weights_to_cdf(int64_t n, T* w, T error_if_below = -std::numeric_limits<T>::epsilon())
:project: RandBLAS

.. doxygenfunction:: RandBLAS::sample_indices_iid_uniform(int64_t n, int64_t k, sint_t* samples, const state_t &state)
.. doxygenfunction:: RandBLAS::sample_indices_iid(int64_t n, const T* cdf, int64_t k, sint_t* samples, const state_t &state)
:project: RandBLAS

.. doxygenfunction:: RandBLAS::sample_indices_iid(int64_t n, const T* cdf, int64_t k, sint_t* samples, const state_t &state)
.. doxygenfunction:: RandBLAS::sample_indices_iid_uniform(int64_t n, int64_t k, sint_t* samples, const state_t &state)
:project: RandBLAS

.. doxygenfunction:: RandBLAS::repeated_fisher_yates(int64_t k, int64_t n, int64_t r, sint_t *samples, const state_t &state)
Expand Down

0 comments on commit 380513a

Please sign in to comment.