Mechanism
=========

.. currentmodule:: negmas.mechanisms

.. autoclass:: Mechanism
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

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

   .. rubric:: Methods Summary

   .. autosummary::

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

   .. 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:: discrete_outcome_space
   .. automethod:: discrete_outcomes
   .. automethod:: from_checkpoint
   .. 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:: nash_points
   .. automethod:: negotiator_index
   .. 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:: set_id
   .. automethod:: spawn
   .. automethod:: spawn_object
   .. automethod:: step
   .. automethod:: stepall