GAMechanism
===========

.. currentmodule:: negmas.ga

.. autoclass:: GAMechanism
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~GAMechanism.agent_ids
      ~GAMechanism.agent_names
      ~GAMechanism.agreement
      ~GAMechanism.atomic_steps
      ~GAMechanism.completed
      ~GAMechanism.current_step
      ~GAMechanism.dynamic_entry
      ~GAMechanism.ended
      ~GAMechanism.expected_relative_time
      ~GAMechanism.expected_remaining_steps
      ~GAMechanism.expected_remaining_time
      ~GAMechanism.genius_negotiator_ids
      ~GAMechanism.history
      ~GAMechanism.id
      ~GAMechanism.issues
      ~GAMechanism.max_n_negotiators
      ~GAMechanism.n_outcomes
      ~GAMechanism.n_steps
      ~GAMechanism.name
      ~GAMechanism.negotiator_ids
      ~GAMechanism.negotiator_names
      ~GAMechanism.negotiator_times
      ~GAMechanism.negotiators
      ~GAMechanism.outcome_space
      ~GAMechanism.outcomes
      ~GAMechanism.participants
      ~GAMechanism.relative_time
      ~GAMechanism.remaining_steps
      ~GAMechanism.remaining_time
      ~GAMechanism.requirements
      ~GAMechanism.running
      ~GAMechanism.short_type_name
      ~GAMechanism.state
      ~GAMechanism.state4history
      ~GAMechanism.stats
      ~GAMechanism.time
      ~GAMechanism.time_limit
      ~GAMechanism.type_name
      ~GAMechanism.uuid
      ~GAMechanism.verbosity

   .. rubric:: Methods Summary

   .. autosummary::

      ~GAMechanism.__call__
      ~GAMechanism.abort
      ~GAMechanism.add
      ~GAMechanism.add_requirements
      ~GAMechanism.announce
      ~GAMechanism.can_accept_more_negotiators
      ~GAMechanism.can_enter
      ~GAMechanism.can_leave
      ~GAMechanism.can_participate
      ~GAMechanism.checkpoint
      ~GAMechanism.checkpoint_final_step
      ~GAMechanism.checkpoint_info
      ~GAMechanism.checkpoint_init
      ~GAMechanism.checkpoint_on_step_started
      ~GAMechanism.create
      ~GAMechanism.crossover
      ~GAMechanism.discrete_outcome_space
      ~GAMechanism.discrete_outcomes
      ~GAMechanism.from_checkpoint
      ~GAMechanism.generate
      ~GAMechanism.genius_id
      ~GAMechanism.get_negotiator
      ~GAMechanism.get_negotiator_raise
      ~GAMechanism.is_satisfying
      ~GAMechanism.is_valid
      ~GAMechanism.kalai_points
      ~GAMechanism.log
      ~GAMechanism.log_critical
      ~GAMechanism.log_debug
      ~GAMechanism.log_error
      ~GAMechanism.log_info
      ~GAMechanism.log_warning
      ~GAMechanism.max_relative_welfare_points
      ~GAMechanism.max_welfare_points
      ~GAMechanism.modified_kalai_points
      ~GAMechanism.mutate
      ~GAMechanism.nash_points
      ~GAMechanism.negotiator_index
      ~GAMechanism.next_generation
      ~GAMechanism.on_mechanism_error
      ~GAMechanism.on_negotiation_end
      ~GAMechanism.on_negotiation_start
      ~GAMechanism.pareto_frontier
      ~GAMechanism.pareto_frontier_bf
      ~GAMechanism.plot
      ~GAMechanism.random_outcome
      ~GAMechanism.random_outcomes
      ~GAMechanism.register_listener
      ~GAMechanism.remove
      ~GAMechanism.remove_requirements
      ~GAMechanism.run
      ~GAMechanism.run_with_progress
      ~GAMechanism.runall
      ~GAMechanism.select
      ~GAMechanism.set_id
      ~GAMechanism.spawn
      ~GAMechanism.spawn_object
      ~GAMechanism.step
      ~GAMechanism.stepall
      ~GAMechanism.update_dominant_outcomes
      ~GAMechanism.update_ranks

   .. rubric:: Attributes Documentation

   .. autoattribute:: agent_ids
   .. autoattribute:: agent_names
   .. autoattribute:: agreement
   .. autoattribute:: atomic_steps
   .. autoattribute:: completed
   .. autoattribute:: current_step
   .. autoattribute:: dynamic_entry
   .. autoattribute:: ended
   .. autoattribute:: expected_relative_time
   .. autoattribute:: expected_remaining_steps
   .. autoattribute:: expected_remaining_time
   .. autoattribute:: genius_negotiator_ids
   .. autoattribute:: history
   .. autoattribute:: id
   .. autoattribute:: issues
   .. autoattribute:: max_n_negotiators
   .. autoattribute:: n_outcomes
   .. autoattribute:: n_steps
   .. autoattribute:: name
   .. autoattribute:: negotiator_ids
   .. autoattribute:: negotiator_names
   .. autoattribute:: negotiator_times
   .. autoattribute:: negotiators
   .. autoattribute:: outcome_space
   .. autoattribute:: outcomes
   .. autoattribute:: participants
   .. autoattribute:: relative_time
   .. autoattribute:: remaining_steps
   .. autoattribute:: remaining_time
   .. autoattribute:: requirements
   .. autoattribute:: running
   .. autoattribute:: short_type_name
   .. autoattribute:: state
   .. autoattribute:: state4history
   .. autoattribute:: stats
   .. autoattribute:: time
   .. autoattribute:: time_limit
   .. autoattribute:: type_name
   .. autoattribute:: uuid
   .. autoattribute:: verbosity

   .. rubric:: Methods Documentation

   .. automethod:: __call__
   .. automethod:: abort
   .. automethod:: add
   .. automethod:: add_requirements
   .. automethod:: announce
   .. automethod:: can_accept_more_negotiators
   .. automethod:: can_enter
   .. automethod:: can_leave
   .. automethod:: can_participate
   .. automethod:: checkpoint
   .. automethod:: checkpoint_final_step
   .. automethod:: checkpoint_info
   .. automethod:: checkpoint_init
   .. automethod:: checkpoint_on_step_started
   .. automethod:: create
   .. automethod:: crossover
   .. automethod:: discrete_outcome_space
   .. automethod:: discrete_outcomes
   .. automethod:: from_checkpoint
   .. automethod:: generate
   .. automethod:: genius_id
   .. automethod:: get_negotiator
   .. automethod:: get_negotiator_raise
   .. automethod:: is_satisfying
   .. automethod:: is_valid
   .. automethod:: kalai_points
   .. automethod:: log
   .. automethod:: log_critical
   .. automethod:: log_debug
   .. automethod:: log_error
   .. automethod:: log_info
   .. automethod:: log_warning
   .. automethod:: max_relative_welfare_points
   .. automethod:: max_welfare_points
   .. automethod:: modified_kalai_points
   .. automethod:: mutate
   .. automethod:: nash_points
   .. automethod:: negotiator_index
   .. automethod:: next_generation
   .. automethod:: on_mechanism_error
   .. automethod:: on_negotiation_end
   .. automethod:: on_negotiation_start
   .. automethod:: pareto_frontier
   .. automethod:: pareto_frontier_bf
   .. automethod:: plot
   .. automethod:: random_outcome
   .. automethod:: random_outcomes
   .. automethod:: register_listener
   .. automethod:: remove
   .. automethod:: remove_requirements
   .. automethod:: run
   .. automethod:: run_with_progress
   .. automethod:: runall
   .. automethod:: select
   .. automethod:: set_id
   .. automethod:: spawn
   .. automethod:: spawn_object
   .. automethod:: step
   .. automethod:: stepall
   .. automethod:: update_dominant_outcomes
   .. automethod:: update_ranks