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.

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

Update documentation #157

Merged
merged 15 commits into from Aug 21, 2017
Merged

Update documentation #157

merged 15 commits into from Aug 21, 2017

Conversation

@haampie
Copy link
Collaborator

@haampie haampie commented Aug 10, 2017

I thought it would be nice to have one page per iterative method and give some short, general information about the method as well as a few lines on notable implementation details.

@haampie haampie changed the title [WIP] Update documentation Update documentation Aug 11, 2017
@haampie
Copy link
Collaborator Author

@haampie haampie commented Aug 11, 2017

See https://haampie.github.io/IterativeSolvers.jl/latest/

I think it is done.

I've removed the "internal" documentation; not sure if it should be added again.

@haampie haampie force-pushed the haampie:update-documentation branch 2 times, most recently from c9cf41b to c1a5818 Aug 11, 2017
src/idrs.jl Outdated
idrs(A, b; kwargs...) = idrs!(zerox(A,b), A, b; kwargs...)

"""
idrs(A, b; s = 8) -> x, [history]

This comment has been minimized.

@mschauer

mschauer Aug 11, 2017
Member

initial guess x0 is missing here?

This comment has been minimized.

This comment has been minimized.

@haampie

haampie Aug 11, 2017
Author Collaborator

Thx!

@haampie
Copy link
Collaborator Author

@haampie haampie commented Aug 16, 2017

I've also added a section on the "iterator approach" https://haampie.github.io/IterativeSolvers.jl/latest/iterators.html

```julia
function my_solver!(x, A, b)
iterable = MySolverIterable(x, A, b)
for item = iterable end

This comment has been minimized.

@mschauer

mschauer Aug 16, 2017
Member

item in iterable reads better

@haampie haampie force-pushed the haampie:update-documentation branch from ef885e4 to 6a2b71a Aug 17, 2017
@andreasnoack andreasnoack merged commit db0702b into JuliaMath:master Aug 21, 2017
1 of 2 checks passed
1 of 2 checks passed
coverage/coveralls Coverage decreased (-0.01%) to 88.442%
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.