diff --git a/docs/make.jl b/docs/make.jl index 987818d..842023a 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -15,8 +15,8 @@ makedocs( "Mutation operators" => "mutation.md", "Population generators" => "generators.md", "Benchmark functions" => "benchmarks.md", - "Stats logbook" => "logbook.md", - "Reporting results" => "results.md" + "Reporting results" => "results.md", + "Logging statistics" => "logbook.md" ], format = Documenter.HTML(prettyurls = false, mathengine = MathJax3()) ) diff --git a/docs/src/results.md b/docs/src/results.md index 3fd76c3..77fb585 100644 --- a/docs/src/results.md +++ b/docs/src/results.md @@ -10,9 +10,9 @@ Result Additionally, some functions are included to obtain specific information about the results of an algorithm. ```@docs -optimizer optimum +optimizer +population iterations f_calls -population ``` diff --git a/src/result.jl b/src/result.jl index d7d134f..c67628f 100644 --- a/src/result.jl +++ b/src/result.jl @@ -2,9 +2,9 @@ """ -The result of an algorithm. The result contains information about the optimizer ``x^*``, -its evaluation ``f(x^*)``, the last state of the population, the number of iterations and -the number of function calls. +The result of an algorithm. The result contains information about the optimum ``f(x^*)``, +the optimizer ``x^*``, the population, the number of iterations and the number of +function calls. """ struct Result fxstar # optimum