FivePeaks
=========

.. currentmodule:: ioh.iohcpp.problem

.. autoclass:: FivePeaks
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~FivePeaks.bounds
      ~FivePeaks.constraints
      ~FivePeaks.create
      ~FivePeaks.log_info
      ~FivePeaks.meta_data
      ~FivePeaks.n_optima
      ~FivePeaks.optima
      ~FivePeaks.optimum
      ~FivePeaks.problems
      ~FivePeaks.rho
      ~FivePeaks.single_global_optimum
      ~FivePeaks.sphere_limit
      ~FivePeaks.state

   .. rubric:: Methods Summary

   .. autosummary::

      ~FivePeaks.__call__
      ~FivePeaks.add_constraint
      ~FivePeaks.attach_logger
      ~FivePeaks.detach_logger
      ~FivePeaks.enforce_bounds
      ~FivePeaks.invert
      ~FivePeaks.remove_constraint
      ~FivePeaks.reset
      ~FivePeaks.set_final_target
      ~FivePeaks.set_id
      ~FivePeaks.set_instance
      ~FivePeaks.set_name
      ~FivePeaks.set_optimum

   .. rubric:: Attributes Documentation

   .. autoattribute:: bounds
   .. autoattribute:: constraints
   .. autoattribute:: create
   .. autoattribute:: log_info
   .. autoattribute:: meta_data
   .. autoattribute:: n_optima
   .. autoattribute:: optima
   .. autoattribute:: optimum
   .. autoattribute:: problems
   .. autoattribute:: rho
   .. autoattribute:: single_global_optimum
   .. autoattribute:: sphere_limit
   .. autoattribute:: state

   .. rubric:: Methods Documentation

   .. automethod:: __call__
   .. automethod:: add_constraint
   .. automethod:: attach_logger
   .. automethod:: detach_logger
   .. automethod:: enforce_bounds
   .. automethod:: invert
   .. automethod:: remove_constraint
   .. automethod:: reset
   .. automethod:: set_final_target
   .. automethod:: set_id
   .. automethod:: set_instance
   .. automethod:: set_name
   .. automethod:: set_optimum