ENH: Create bindings for SPQR#151
Merged
Merged
Conversation
Create utils.py and test_utils.py.
The function does *not* accept csc_matrix inputs (deprecated API), so be explicit about the input not being in csc_array format.
Also fix docs where imports were from cholmod vs. amd/camd.
This commit restructures the existing docs to be more like the SciPy docs with an API reference page that will just list every submodule and function.
This commit uses the Furo theme to add a light/dark colorscheme button and simplify the style. There was an issue with the PyData theme's "search" feature on build, so use Furo for now. This commit also adds the `sphinx.ext.autosummary` to create separate pages for each function/method. It is much easier to read the documentation with less scrolling.
This commit begins the consolidation of documentation into the individual module docstrings, like what SciPy does for `scipy.sparse`, `scipy.linalg`, etc. Documentation for each submodule will be located within that submodule itself, not a separate docs file.
This change keeps the API summaries in a single location, instead of blending the API summary and User Guide into a single rst file in the documentation.
The rst files in doc/reference are now just stub files with "automodule", and the actual documentation is in the docstring of each module.
This commit makes class pages like `CholeskyFactor` mimic the numpy/scipy documentation that has separate pages for each class method, instead of listing them all in-line on a single page.
Previously, we just converted every input to a dense array. Now, use overloads for cholmod_sparse.
mode="raw" refers specifically to the LAPACK output used in `scipy.linalg.qr`, but here we are not returning "raw" output, per se, just the Householder form. Be explicit about it.
Unused until we can extract the factors from the SuiteSparseQR_factorization struct.
This commit changes the value of SPQRFactor.rank to "None" when only a symbolic analysis has been done.
Refer to `spqr_freefac.cpp` to see the actual sizes, since they are not all accurately documented in the comments of SuiteSparseQR.hpp.
Much clearer to read the code.
4c63ee3 to
fb6ab39
Compare
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds an interface to the SuiteSparse SPQR package. It is built on top of the development branch in #145, so it will show many more commits before that is merged.