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

merged 2 commits into from
Dec 7, 2021

Conversation

Michael-T-McCann
Copy link
Contributor

Typos, clarifications, etc. Placed here to avoid cluttering the history with small commits.

@codecov
Copy link

codecov bot commented Nov 8, 2021 •
edited
Loading

Codecov Report

Merging #77 (403eaf5) into main (fb4f81e) will not change coverage.
The diff coverage is n/a.

❗ Current head 403eaf5 differs from pull request most recent head dd9909e. Consider uploading reports for the commit dd9909e to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main      #77   +/-   ##
=======================================
  Coverage   91.26%   91.26%           
=======================================
  Files          44       44           
  Lines        3160     3160           
=======================================
  Hits         2884     2884           
  Misses        276      276
Flag Coverage Δ
unittests 91.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
scico/solver.py 98.88% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fb4f81e...dd9909e. Read the comment docs.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Nov 9, 2021
@Michael-T-McCann Michael-T-McCann marked this pull request as ready for review December 7, 2021 15:58
@Michael-T-McCann Michael-T-McCann enabled auto-merge (squash) December 7, 2021 15:58
@Michael-T-McCann Michael-T-McCann merged commit 573d86d into main Dec 7, 2021
lukepfister
lukepfister reviewed Dec 7, 2021
View reviewed changes
scico/solver.py
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.

@Michael-T-McCann Michael-T-McCann deleted the mike/docs branch December 13, 2021 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukepfister lukepfister lukepfister left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Michael-T-McCann @lukepfister @bwohlberg