DOC: Add examples for some root finding functions. #12752
Merged
Conversation
This file contains 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
AtsushiSakai
added
Documentation
rgommers
approved these changes
Nov 1, 2020
There was a problem hiding this comment.
LGTM, thanks @AtsushiSakai
I tried to find good Examples for
linearmixing,excitingmixing, however, I couldn't find a converged example yet.
As the warnings at the top of the docstrings for those functions indicate, they're not very good solvers. I think it's fine to ignore them, if they can't even solve such simple examples we may want to get rid of them at some point.
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.
Reference issue
fix a part of #7168
What does this implement/fix?
I added Examples for
anderson,broyden1,broyden2,diagbroyden,newton_krylovin optimize module.I tried to find good Examples for
linearmixing,excitingmixing, however, I couldn't find a converged example yet.