freealg 0.3.2__tar.gz → 0.3.3__tar.gz

{freealg-0.3.2 → freealg-0.3.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: freealg
-Version: 0.3.2
+Version: 0.3.3
 Summary: Free probability for large matrices
 Home-page: https://github.com/ameli/freealg
 Download-URL: https://github.com/ameli/freealg/archive/main.zip
-Project-URL: Documentation, https://github.com/ameli/freealg/blob/main/README.rst
+Project-URL: Documentation, https://ameli.github.io/freealg
 Project-URL: Source, https://github.com/ameli/freealg
 Project-URL: Tracker, https://github.com/ameli/freealg/issues
 Keywords: linalg,free-probability
@@ -59,6 +59,7 @@ Requires-Dist: sphinx-gallery; extra == "docs"
 Requires-Dist: sphinxcontrib-youtube; extra == "docs"
 Requires-Dist: sphinxext-opengraph; extra == "docs"
 Requires-Dist: sphinx-argparse; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
 Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
@@ -73,10 +74,14 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-.. image:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
+.. .. image:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
+..     :align: left
+..     :width: 240
+..     :class: custom-dark
+
+.. figure:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
     :align: left
     :width: 240
-    :class: custom-dark
 
 `Paper <https://arxiv.org/abs/2506.11994>`__ |
 `Slides <https://www.dropbox.com/scl/fi/03gjuyz17k9yhsqy0isoz/free_decomporession_slides.pdf?rlkey=8f82mhciyl2ju02l7hv1md5li&st=26xmhjga&dl=0>`__ |
@@ -85,10 +90,11 @@ Dynamic: summary
 
 .. `Slides <https://ameli.github.io/freealg/_static/data/slides.pdf>`__ |
 
-*freealg* is a Python package that employs **free** probability to evaluate the spectral
-densities of large matrix **form**\ s. The fundamental algorithm employed by *freealg* is
-**free decompression**, which extrapolates from the empirical spectral densities of small 
-submatrices to infer the eigenspectrum of extremely large matrices. 
+*freealg* is a Python package that employs **free** probability to evaluate the
+spectral densities of large matrix **form**\ s. The fundamental algorithm
+employed by *freealg* is **free decompression**, which extrapolates from the
+empirical spectral densities of small  submatrices to infer the eigenspectrum
+of extremely large matrices. 
 
 Install
 =======
@@ -114,8 +120,8 @@ Documentation is available at `ameli.github.io/freealg <https://ameli.github.io/
 Quick Usage
 ===========
 
-The following code estimates the eigenvalues of a very large Wishart matrix using a much
-smaller Wishart matrix.
+The following code estimates the eigenvalues of a very large Wishart matrix
+using a much smaller Wishart matrix.
 
 .. code-block:: python
 
@@ -124,7 +130,8 @@ smaller Wishart matrix.
     >>> A = mp.matrix(1000)                         # Sample a 1000 x 1000 Wishart matrix
     >>> eigs = fa.eigfree(A, 100_000)               # Estimate the eigenvalues of 100000 x 100000
 
-For more details on how to interface with *freealg* check out the `Quick Start Guide <https://github.com/ameli/freealg/blob/main/notebooks/quick_start.ipynb>`__.
+For more details on how to interface with *freealg* check out the 
+`Quick Start Guide <https://github.com/ameli/freealg/blob/main/notebooks/quick_start.ipynb>`__.
 
 
 Test
@@ -148,9 +155,9 @@ How to Contribute
 =================
 
 We welcome contributions via GitHub's pull request. Developers should review
-our [Contributing Guidelines](CONTRIBUTING.rst) before submitting their code.
-If you do not feel comfortable modifying the code, we also welcome feature
-requests and bug reports.
+our [Contributing Guidelines](https://github.com/ameli/freealg/blob/main/CONTRIBUTING.rst)
+before submitting their code. If you do not feel comfortable modifying the
+code, we also welcome feature requests and bug reports.
 
 How to Cite
 ===========

{freealg-0.3.2 → freealg-0.3.3}/README.rst

@@ -1,7 +1,11 @@
-.. image:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
+.. .. image:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
+..     :align: left
+..     :width: 240
+..     :class: custom-dark
+
+.. figure:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
     :align: left
     :width: 240
-    :class: custom-dark
 
 `Paper <https://arxiv.org/abs/2506.11994>`__ |
 `Slides <https://www.dropbox.com/scl/fi/03gjuyz17k9yhsqy0isoz/free_decomporession_slides.pdf?rlkey=8f82mhciyl2ju02l7hv1md5li&st=26xmhjga&dl=0>`__ |
@@ -10,10 +14,11 @@
 
 .. `Slides <https://ameli.github.io/freealg/_static/data/slides.pdf>`__ |
 
-*freealg* is a Python package that employs **free** probability to evaluate the spectral
-densities of large matrix **form**\ s. The fundamental algorithm employed by *freealg* is
-**free decompression**, which extrapolates from the empirical spectral densities of small 
-submatrices to infer the eigenspectrum of extremely large matrices. 
+*freealg* is a Python package that employs **free** probability to evaluate the
+spectral densities of large matrix **form**\ s. The fundamental algorithm
+employed by *freealg* is **free decompression**, which extrapolates from the
+empirical spectral densities of small  submatrices to infer the eigenspectrum
+of extremely large matrices. 
 
 Install
 =======
@@ -39,8 +44,8 @@ Documentation is available at `ameli.github.io/freealg <https://ameli.github.io/
 Quick Usage
 ===========
 
-The following code estimates the eigenvalues of a very large Wishart matrix using a much
-smaller Wishart matrix.
+The following code estimates the eigenvalues of a very large Wishart matrix
+using a much smaller Wishart matrix.
 
 .. code-block:: python
 
@@ -49,7 +54,8 @@ smaller Wishart matrix.
     >>> A = mp.matrix(1000)                         # Sample a 1000 x 1000 Wishart matrix
     >>> eigs = fa.eigfree(A, 100_000)               # Estimate the eigenvalues of 100000 x 100000
 
-For more details on how to interface with *freealg* check out the `Quick Start Guide <https://github.com/ameli/freealg/blob/main/notebooks/quick_start.ipynb>`__.
+For more details on how to interface with *freealg* check out the 
+`Quick Start Guide <https://github.com/ameli/freealg/blob/main/notebooks/quick_start.ipynb>`__.
 
 
 Test
@@ -73,9 +79,9 @@ How to Contribute
 =================
 
 We welcome contributions via GitHub's pull request. Developers should review
-our [Contributing Guidelines](CONTRIBUTING.rst) before submitting their code.
-If you do not feel comfortable modifying the code, we also welcome feature
-requests and bug reports.
+our [Contributing Guidelines](https://github.com/ameli/freealg/blob/main/CONTRIBUTING.rst)
+before submitting their code. If you do not feel comfortable modifying the
+code, we also welcome feature requests and bug reports.
 
 How to Cite
 ===========

freealg-0.3.3/freealg/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.3.3"

{freealg-0.3.2 → freealg-0.3.3}/freealg/eigh.py

@@ -17,12 +17,19 @@ from .freeform import FreeForm
 __all__ = ['eigh', 'cond', 'norm', 'trace', 'slogdet']
 
 
+# ===============
+# subsample apply
+# ===============
+
 def _subsample_apply(f, A, output_array=False):
-    """Compute f(A_n) over subsamples A_n of A. If the output of
-    f is an array (e.g. eigvals), specify output_array to be True."""
+    """
+    Compute f(A_n) over subsamples A_n of A. If the output of
+    f is an array (e.g. eigvals), specify output_array to be True.
+    """
 
     if A.ndim != 2 or A.shape[0] != A.shape[1]:
         raise RuntimeError("Only square matrices are permitted.")
+
     n = A.shape[0]
 
     # Size of sample matrix
@@ -30,6 +37,7 @@ def _subsample_apply(f, A, output_array=False):
     # If matrix is not large enough, return eigenvalues
     if n < n_s:
         return f(A), n, n
+
     # Number of samples
     num_samples = int(10 * (n / n_s)**0.5)
 
@@ -38,6 +46,7 @@ def _subsample_apply(f, A, output_array=False):
     for _ in range(num_samples):
         indices = numpy.random.choice(n, n_s, replace=False)
         samples.append(f(A[numpy.ix_(indices, indices)]))
+
     if output_array:
         return numpy.concatenate(samples).ravel(), n, n_s
 
@@ -113,6 +122,7 @@ def eigh(A, N=None, psd=None, plots=False):
         >>> A = mp.matrix(3000)
         >>> eigs = eigh(A)
     """
+
     samples, n, n_s = _subsample_apply(compute_eig, A, output_array=True)
 
     if N is None:
@@ -367,6 +377,7 @@ def trace(A, N=None, p=1.0):
         >>> A = mp.matrix(3000)
         >>> trace(A, 100_000)
     """
+
     if numpy.isclose(p, 1.0):
         samples, n, n_s = _subsample_apply(numpy.trace, A, output_array=False)
         if N is None:

{freealg-0.3.2 → freealg-0.3.3}/freealg.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: freealg
-Version: 0.3.2
+Version: 0.3.3
 Summary: Free probability for large matrices
 Home-page: https://github.com/ameli/freealg
 Download-URL: https://github.com/ameli/freealg/archive/main.zip
-Project-URL: Documentation, https://github.com/ameli/freealg/blob/main/README.rst
+Project-URL: Documentation, https://ameli.github.io/freealg
 Project-URL: Source, https://github.com/ameli/freealg
 Project-URL: Tracker, https://github.com/ameli/freealg/issues
 Keywords: linalg,free-probability
@@ -59,6 +59,7 @@ Requires-Dist: sphinx-gallery; extra == "docs"
 Requires-Dist: sphinxcontrib-youtube; extra == "docs"
 Requires-Dist: sphinxext-opengraph; extra == "docs"
 Requires-Dist: sphinx-argparse; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
 Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
@@ -73,10 +74,14 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-.. image:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
+.. .. image:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
+..     :align: left
+..     :width: 240
+..     :class: custom-dark
+
+.. figure:: https://raw.githubusercontent.com/ameli/freealg/refs/heads/main/docs/source/_static/images/icons/logo-freealg-light.png
     :align: left
     :width: 240
-    :class: custom-dark
 
 `Paper <https://arxiv.org/abs/2506.11994>`__ |
 `Slides <https://www.dropbox.com/scl/fi/03gjuyz17k9yhsqy0isoz/free_decomporession_slides.pdf?rlkey=8f82mhciyl2ju02l7hv1md5li&st=26xmhjga&dl=0>`__ |
@@ -85,10 +90,11 @@ Dynamic: summary
 
 .. `Slides <https://ameli.github.io/freealg/_static/data/slides.pdf>`__ |
 
-*freealg* is a Python package that employs **free** probability to evaluate the spectral
-densities of large matrix **form**\ s. The fundamental algorithm employed by *freealg* is
-**free decompression**, which extrapolates from the empirical spectral densities of small 
-submatrices to infer the eigenspectrum of extremely large matrices. 
+*freealg* is a Python package that employs **free** probability to evaluate the
+spectral densities of large matrix **form**\ s. The fundamental algorithm
+employed by *freealg* is **free decompression**, which extrapolates from the
+empirical spectral densities of small  submatrices to infer the eigenspectrum
+of extremely large matrices. 
 
 Install
 =======
@@ -114,8 +120,8 @@ Documentation is available at `ameli.github.io/freealg <https://ameli.github.io/
 Quick Usage
 ===========
 
-The following code estimates the eigenvalues of a very large Wishart matrix using a much
-smaller Wishart matrix.
+The following code estimates the eigenvalues of a very large Wishart matrix
+using a much smaller Wishart matrix.
 
 .. code-block:: python
 
@@ -124,7 +130,8 @@ smaller Wishart matrix.
     >>> A = mp.matrix(1000)                         # Sample a 1000 x 1000 Wishart matrix
     >>> eigs = fa.eigfree(A, 100_000)               # Estimate the eigenvalues of 100000 x 100000
 
-For more details on how to interface with *freealg* check out the `Quick Start Guide <https://github.com/ameli/freealg/blob/main/notebooks/quick_start.ipynb>`__.
+For more details on how to interface with *freealg* check out the 
+`Quick Start Guide <https://github.com/ameli/freealg/blob/main/notebooks/quick_start.ipynb>`__.
 
 
 Test
@@ -148,9 +155,9 @@ How to Contribute
 =================
 
 We welcome contributions via GitHub's pull request. Developers should review
-our [Contributing Guidelines](CONTRIBUTING.rst) before submitting their code.
-If you do not feel comfortable modifying the code, we also welcome feature
-requests and bug reports.
+our [Contributing Guidelines](https://github.com/ameli/freealg/blob/main/CONTRIBUTING.rst)
+before submitting their code. If you do not feel comfortable modifying the
+code, we also welcome feature requests and bug reports.
 
 How to Cite
 ===========

{freealg-0.3.2 → freealg-0.3.3}/freealg.egg-info/requires.txt

@@ -24,6 +24,7 @@ sphinx-gallery
 sphinxcontrib-youtube
 sphinxext-opengraph
 sphinx-argparse
+sphinx-sitemap
 
 [test]
 tox

{freealg-0.3.2 → freealg-0.3.3}/setup.py

@@ -161,7 +161,7 @@ def main(argv):
     # URLs
     url = 'https://github.com/ameli/freealg'
     download_url = url + '/archive/main.zip'
-    documentation_url = url + '/blob/main/README.rst'
+    documentation_url = 'https://ameli.github.io/freealg'
     tracker_url = url + '/issues'
 
     # Inputs to setup

freealg-0.3.2/freealg/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.3.2"