File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11docs /build
22docs /Manifest.toml
3+ Manifest.toml
Original file line number Diff line number Diff line change 11# AlgorithmsInterface.jl
22
3- Welcome to the Documentation of ` LieGAlgorithmsInterface .jl` .
3+ Welcome to the Documentation of ` AlgorithmsInterface .jl` .
44
55``` @meta
66CurrentModule = AlgorithmsInterface
Original file line number Diff line number Diff line change @@ -6,16 +6,16 @@ The interface this package provides is based on three ingredients of running an
66consists of:
77
88* a [ ` Problem ` ] ( @ref ) that is to be solved and contains all information that is algorithm independent.
9- This is _ static information_ in the sense that it does not change during the runtime of the algorithm
9+ This is _ static information_ in the sense that it does not change during the runtime of the algorithm.
1010* an [ ` Algorithm ` ] ( @ref ) that includes all of the _ settings_ and _ parameters_ that an algorithm.
11- this is also information that is _ static_
11+ this is also information that is _ static_ .
1212* a [ ` State ` ] ( @ref ) that contains all remaining data, especially data that might vary during the iteration,
1313 temporary caches, for example the current iteration the algorithm run is in and the current iterate, respectively.
1414
1515The combination of the static information should be enough to initialize the varying data.
1616
1717This general scheme is a guiding principle of the package, splitting information into _ static_
18- or _ configuration_ types or data that allows to [ ` initialize_state ` ] ( @ref ) a correspondint _ variable_ data type.
18+ or _ configuration_ types or data that allows to [ ` initialize_state ` ] ( @ref ) a corresponding _ variable_ data type.
1919
2020The order of arguments is given by two ideas
2121
You can’t perform that action at this time.
0 commit comments