Skip to content

Update newton function to return x instead of y #14

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

Closed
wants to merge 1 commit into from
Closed

Update newton function to return x instead of y #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions src/newton.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ Finds roots of f!(y, x) using Newton's method.

# Arguments
- `f!`: Function that mutates y in place with the residual vector
- `y`: Solution vector
- `x`: Initial guess
- `y`: Solution vector


# Keyword arguments
- `abstol`: Convergence absolute tolerance (default: 1e-13)
Expand All @@ -17,8 +18,8 @@ Returns `NamedTuple` containing newton search results.
"""
function newton!(
f!::Function, # DO NOT SPECIALIZE ON FUNCTION! This is the mistake SciML makes...
y::Y,
x::X,
y::Y,
p; # Parameters
reltol=1e-13,
abstol=1e-13,
Expand All @@ -39,9 +40,9 @@ function newton!(
if S
eg = eigen(jac)
stable = all(t->norm(t)<=1, eg.values)
return (;u=y, converged=true, n_iters=iter, stable=stable)
return (;u=x, converged=true, n_iters=iter, stable=stable)
else
return (;u=y, converged=true, n_iters=iter)
return (;u=x, converged=true, n_iters=iter)
end
end
# store in y
Expand All @@ -51,16 +52,16 @@ function newton!(
if S
eg = eigen(jac)
stable = all(t->norm(t)<=1, eg.values)
return (;u=y, converged=true, n_iters=iter, stable=stable)
return (;u=x, converged=true, n_iters=iter, stable=stable)
else
return (;u=y, converged=true, n_iters=iter)
return (;u=x, converged=true, n_iters=iter)
end
end
x .= x .+ y
end
if S
return (;u=y, converged=false, n_iters=max_iter, stable=false)
return (;u=x, converged=false, n_iters=max_iter, stable=false)
else
return (;u=y, converged=false, n_iters=max_iter)
return (;u=x, converged=false, n_iters=max_iter)
end
end