geneticengine.algorithms.api
============================

.. py:module:: geneticengine.algorithms.api


Classes
-------

.. autoapisummary::

   geneticengine.algorithms.api.SynthesisAlgorithm


Module Contents
---------------

.. py:class:: SynthesisAlgorithm(problem, budget, tracker = None)

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: tracker
      :type:  geneticengine.evaluation.tracker.ProgressTracker


   .. py:attribute:: problem
      :type:  geneticengine.problems.Problem


   .. py:attribute:: budget
      :type:  geneticengine.evaluation.budget.SearchBudget


   .. py:method:: is_done()

      Whether the synthesis should stop, or not.



   .. py:method:: get_problem()


   .. py:method:: search()


   .. py:method:: perform_search()
      :abstractmethod: