Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

A collection of small docs updates #77

Merged
merged 2 commits into from
Dec 7, 2021
Merged

A collection of small docs updates #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bab01f6
Add note about squash and merge
Michael-T-McCann Nov 8, 2021
dd9909e
Clarify cg problem
Michael-T-McCann Nov 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,10 @@ A feature development workflow might look like this:

9. Create a new pull request to the ``main`` branch; see `the GitHub instructions <https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_.

10. The SCICO maintainers will review and merge your PR.
The SCICO project favors the ``squash and merge`` option for merging PRs.

10. Delete the branch after it has been merged.
11. Delete the branch after it has been merged.


Tests
Expand Down
8 changes: 4 additions & 4 deletions scico/solver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,20 +257,20 @@ def cg(
) -> Union[JaxArray, dict]:
r"""Conjugate Gradient solver.

Solve the linear system :math:`A\mb{x} = \mb{b}` via the conjugate
gradient method.
Solve the linear system :math:`A\mb{x} = \mb{b}`, where :math:`A` is
positive definite, via the conjugate gradient method.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs to be symmetric, too

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confusingly, I think most authors make positive definite operators a subset of self-adjoint operators, so positive definite -> symmetric.


Args:
A: Function implementing linear operator :math:`A`.
b: Input array :math:`\mb{b}`.
b: Input array :math:`\mb{b}`, should be positive definite.
x0: Initial solution.
tol: Relative residual stopping tolerance. Convergence occurs
when ``norm(residual) <= max(tol * norm(b), atol)``.
atol: Absolute residual stopping tolerance. Convergence occurs
when ``norm(residual) <= max(tol * norm(b), atol)``.
maxiter: Maximum iterations. Default: 1000.
M: Preconditioner for A. The preconditioner should approximate
the inverse of ``A``. The default, ``None``, does not use a
the inverse of ``A``. The default, ``None``, uses no
preconditioner.

Returns:
Expand Down