You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Readme.md
+17-3Lines changed: 17 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,13 +14,27 @@ A common interface for algorithms allows to reuse common code – especially sto
14
14
15
15
We consider solving _Tasks_, which consist of a
16
16
17
-
*`Problem` to solve, which constains all information that is static to the problem and usually does not change during the iterations, this might for example be a cost function and its gradient in an optimisation problem
18
-
* An `AlgorithmState` that both specifies which algorithm to use to _solve_ the problem, but also stores all parameters that an algorithm needs as well as everything the algorithm needs to store between two iterations.
17
+
*`AbstractProblem` to solve, which contains all information that is static to the problem and usually does not change during the iterations, this might for example be a cost function and its gradient in an optimisation problem
18
+
* An `AbstractAlgorithmState` that both specifies which algorithm to use to _solve_ the problem, but also stores all parameters that an algorithm needs as well as everything the algorithm needs to store between two iterations.
19
19
20
20
This generic data structures are accompanied by the methods
21
21
22
22
*`step!(problem::Problem, state::AlgorithmState, k)` to perform the `k`th iteration of the algorithm.
23
23
*`solve!(problem::Problem, state::AlgorithmState)` to solve a problem with a given algorithm, which is identified by the `AlgorithmState`.
24
24
*`stop(problem::Problem, state::AlgorithmState)` to check whether the algorithm should stop.
25
25
26
-
where the first is the main one to implement for a new algorithm.
26
+
where the first is the main one to implement for a new algorithm.
0 commit comments