diff --git a/docs/bibliography.rst b/docs/bibliography.rst index 4f8a8d8..7e24103 100644 --- a/docs/bibliography.rst +++ b/docs/bibliography.rst @@ -17,4 +17,4 @@ Bibliography .. [Dodis2004] Y. Dodis, A. Elbaz, R. Oliveira, and R. Raz, `Improved randomness extraction from two independent sources `_ in Proceedings RANDOM, vol. 3122, pp. 334–344 (2004) -.. [For2024] C. Foreman, R. Yeung, A. Edgington et al. `Cryptomite: A versatile and user-friendly library of randomness extractors`_, Pre-print (2024) \ No newline at end of file +.. [For2024] C. Foreman, R. Yeung, A. Edgington et al. `Cryptomite: A versatile and user-friendly library of randomness extractors`, Pre-print (2024) \ No newline at end of file diff --git a/docs/cryptomite.rst b/docs/cryptomite.rst index 6bc2224..40df5ee 100644 --- a/docs/cryptomite.rst +++ b/docs/cryptomite.rst @@ -5,7 +5,7 @@ Submodules ---------- cryptomite.circulant module ------------------------ +--------------------------- .. automodule:: cryptomite.circulant :members: diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index fe6d35a..d1db055 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -1,7 +1,7 @@ Selecting a Randomness Extractor ================================ In general, the choice of randomness extractor depends on the scenario in which it is to be used and, it is not always clear which extractor is best suited to a given scenario. -In this section, we (informally) help solve this problem, based on the section 'Overview of Extractor Library' from Cryptomite's accompanying paper (see :ref:`For2024`). +In this section, we (informally) help solve this problem, based on the section 'Overview of Extractor Library' from Cryptomite's accompanying paper (see [For2024]_). We use the notation :math:`n_1, n_2` to denote the length and :math:`k_1, k_2` to denote the :term:`min-entropy` of any first or second input string respectively. Additionally, :math:`m` denotes the length of an output string, :math:`\epsilon` the extractor error and :math:`O(.)` denotes asymptotic quantities. diff --git a/docs/notebooks.rst b/docs/notebooks.rst index 96d30f6..4e7cac5 100644 --- a/docs/notebooks.rst +++ b/docs/notebooks.rst @@ -1,9 +1,9 @@ .. _sec-examples: Example Usage -======== +============= -Here we give examples of using ``Cryptomite``: +Here we give examples of using ``cryptomite``: .. toctree:: diff --git a/docs/performance.rst b/docs/performance.rst index e655404..56857a0 100644 --- a/docs/performance.rst +++ b/docs/performance.rst @@ -1,5 +1,5 @@ Performance -========== +=========== To demonstrate the capabilities of :py:mod:`Cryptomite`, we perform some bench-marking on a MacBook Pro personal laptop (with 2 GHz quad-core Intel i5 processor with 16GB RAM). The speed (throughput) for the standard versions of :py:mod:`Cryptomite` extractors are evidenced in the following figure.