Skip to content

Commit

Permalink
generate api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
KRM7 committed Sep 21, 2024
1 parent 4ff4f9e commit 1983d49
Show file tree
Hide file tree
Showing 208 changed files with 46,622 additions and 0 deletions.
Empty file added docs/.nojekyll
Empty file.
27 changes: 27 additions & 0 deletions docs/_sources/algorithm/algorithm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Algorithms
===================================================

.. toctree::
:maxdepth: 1

algorithm_soga
algorithm_moga


.. doxygennamespace:: gapp::algorithm
:project: gapp
:desc-only:


class Algorithm
---------------------------------------------------

.. code-block::
#include <algorithm/algorithm_base.hpp>
.. doxygenclass:: gapp::algorithm::Algorithm
:project: gapp
:members:
:protected-members:
:private-members:
60 changes: 60 additions & 0 deletions docs/_sources/algorithm/algorithm_moga.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Multi-objective algorithms
===================================================

.. doxygennamespace:: gapp::algorithm
:project: gapp
:desc-only:


class NSGA2
---------------------------------------------------

.. code-block::
#include <algorithm/nsga2.hpp>
.. doxygenclass:: gapp::algorithm::NSGA2
:project: gapp
:members:
:protected-members:


class NSGA3
---------------------------------------------------

.. code-block::
#include <algorithm/nsga3.hpp>
.. doxygenclass:: gapp::algorithm::NSGA3
:project: gapp
:members:
:protected-members:


Reference line generation methods
---------------------------------------------------

.. doxygennamespace:: gapp::algorithm::reflines
:project: gapp
:desc-only:

.. code-block::
#include <algorithm/reference_lines.hpp>
.. doxygenfunction:: gapp::algorithm::reflines::quasirandomSimplexPointsMirror
:project: gapp

.. doxygenfunction:: gapp::algorithm::reflines::quasirandomSimplexPointsSort
:project: gapp

.. doxygenfunction:: gapp::algorithm::reflines::quasirandomSimplexPointsRoot
:project: gapp

.. doxygenfunction:: gapp::algorithm::reflines::quasirandomSimplexPointsLog
:project: gapp

.. doxygenfunction:: gapp::algorithm::reflines::pickSparseSubset
:project: gapp

46 changes: 46 additions & 0 deletions docs/_sources/algorithm/algorithm_replacement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Replacement methods
===================================================

.. doxygennamespace:: gapp::replacement
:project: gapp
:desc-only:


class KeepChildren
---------------------------------------------------

.. code-block::
#include <algorithm/soga_replacement.hpp>
.. doxygenclass:: gapp::replacement::KeepChildren
:project: gapp
:members:
:protected-members:


class Elitism
---------------------------------------------------

.. code-block::
#include <algorithm/soga_replacement.hpp>
.. doxygenclass:: gapp::replacement::Elitism
:project: gapp
:members:
:protected-members:


class KeepBest
---------------------------------------------------

.. code-block::
#include <algorithm/soga_replacement.hpp>
.. doxygenclass:: gapp::replacement::KeepBest
:project: gapp
:members:
:protected-members:

72 changes: 72 additions & 0 deletions docs/_sources/algorithm/algorithm_selection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Selection methods
===================================================

.. doxygennamespace:: gapp::selection
:project: gapp
:desc-only:


class Roulette
---------------------------------------------------

.. code-block::
#include <algorithm/soga_selection.hpp>
.. doxygenclass:: gapp::selection::Roulette
:project: gapp
:members:
:protected-members:


class Tournament
---------------------------------------------------

.. code-block::
#include <algorithm/soga_selection.hpp>
.. doxygenclass:: gapp::selection::Tournament
:project: gapp
:members:
:protected-members:


class Rank
---------------------------------------------------

.. code-block::
#include <algorithm/soga_selection.hpp>
.. doxygenclass:: gapp::selection::Rank
:project: gapp
:members:
:protected-members:


class Sigma
---------------------------------------------------

.. code-block::
#include <algorithm/soga_selection.hpp>
.. doxygenclass:: gapp::selection::Sigma
:project: gapp
:members:
:protected-members:


class Boltzmann
---------------------------------------------------

.. code-block::
#include <algorithm/soga_selection.hpp>
.. doxygenclass:: gapp::selection::Boltzmann
:project: gapp
:members:
:protected-members:

61 changes: 61 additions & 0 deletions docs/_sources/algorithm/algorithm_soga.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Single-objective algorithms
===================================================

.. toctree::
:maxdepth: 1

algorithm_selection
algorithm_replacement


class SingleObjective
---------------------------------------------------

.. code-block::
#include <algorithm/single_objective.hpp>
.. doxygennamespace:: gapp::algorithm
:project: gapp
:desc-only:

.. doxygenclass:: gapp::algorithm::SingleObjective
:project: gapp
:members:
:protected-members:


class Selection
---------------------------------------------------

.. code-block::
#include <algorithm/selection_base.hpp>
.. doxygennamespace:: gapp::selection
:project: gapp
:desc-only:

.. doxygenclass:: gapp::selection::Selection
:project: gapp
:members:
:protected-members:
:private-members:


class Replacement
---------------------------------------------------

.. code-block::
#include <algorithm/replacement_base.hpp>
.. doxygennamespace:: gapp::replacement
:project: gapp
:desc-only:

.. doxygenclass:: gapp::replacement::Replacement
:project: gapp
:members:
:protected-members:
:private-members:
43 changes: 43 additions & 0 deletions docs/_sources/core/encoding_binary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Binary-encoded genetic algorithm
===================================================

.. doxygennamespace:: gapp
:project: gapp
:desc-only:


class BinaryGene
---------------------------------------------------

.. code-block::
#include <encoding/binary.hpp>
.. doxygentypedef:: gapp::BinaryGene
:project: gapp


class GaTraits<BinaryGene>
---------------------------------------------------

.. code-block::
#include <encoding/binary.hpp>
.. doxygenstruct:: gapp::GaTraits< BinaryGene >
:project: gapp
:members:
:undoc-members:


class BinaryGA
---------------------------------------------------

.. code-block::
#include <encoding/binary.hpp>
.. doxygenclass:: gapp::BinaryGA
:project: gapp
:members:
:protected-members:
43 changes: 43 additions & 0 deletions docs/_sources/core/encoding_integer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Integer-encoded genetic algorithm
===================================================

.. doxygennamespace:: gapp
:project: gapp
:desc-only:


class IntegerGene
---------------------------------------------------

.. code-block::
#include <encoding/integer.hpp>
.. doxygentypedef:: gapp::IntegerGene
:project: gapp


class GaTraits<IntegerGene>
---------------------------------------------------

.. code-block::
#include <encoding/integer.hpp>
.. doxygenstruct:: gapp::GaTraits< IntegerGene >
:project: gapp
:members:
:undoc-members:


class IntegerGA
---------------------------------------------------

.. code-block::
#include <encoding/integer.hpp>
.. doxygenclass:: gapp::IntegerGA
:project: gapp
:members:
:protected-members:
Loading

0 comments on commit 1983d49

Please sign in to comment.