Skip to content

Commit

Permalink
fix spelling typos
Browse files Browse the repository at this point in the history
briochemc committed May 6, 2019
1 parent e72e619 commit f1f2758
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -79,7 +79,7 @@ To use the F-1 method, the user must:

## A concrete example

Make sure you have olverloaded `solve` from DiffEqBase
Make sure you have overloaded `solve` from DiffEqBase
(an example of how to do this is given in the [documentation](https://briochemc.github.io/F1Method.jl/stable/)).
Once initial values for the state, `x₀`, and parameters, `p₀`, are chosen, simply initialize the required memory cache, `mem` via

4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -43,7 +43,7 @@ F(x,p) = [
```

We also define a cost function `f(x,p)` (that we wish to minimize under the constraint that ``\boldsymbol{F}(\boldsymbol{x},\boldsymbol{p}) = 0``).
(The F-1 method requires that we provide the derivatives w.r.t. the state, `x`, hence the use of ForwardDiff again for this exmaple.)
(The F-1 method requires that we provide the derivatives w.r.t. the state, `x`, hence the use of ForwardDiff again for this example.)

```jldoctest usage
# Define mismatch function f(x,p) and its derivative ∇ₓf(x,p)
@@ -65,7 +65,7 @@ f(x,p) = state_mismatch(x) + parameter_mismatch(p)
```

Once these are set up, we need to let the F-1 method know how to solve for the steady-state.
We do this by using the DiffEqBase API.
We do this by using the [DiffEqBase](https://github.com/JuliaDiffEq/DiffEqBase.jl) API.
For that, we first write a small Newton solver algorithm, we overload the `solve` function from DiffEqBase, and we overload the `SteadyStateProblem` constructor.

```jldoctest usage

0 comments on commit f1f2758

Please sign in to comment.