scml.oneshot.agents.nothing
===========================

.. py:module:: scml.oneshot.agents.nothing


Classes
-------

.. autoapisummary::

   scml.oneshot.agents.nothing.OneshotDoNothingAgent
   scml.oneshot.agents.nothing.Placeholder


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

.. py:class:: OneshotDoNothingAgent(owner=None, ufun: scml.oneshot.OneShotUFun | None = None, name=None)

   Bases: :py:obj:`scml.oneshot.agent.OneShotAgent`


   An agent that does nothing.

   Remarks:

       Note that this agent will lose money whenever it is at the edges (i.e.
       it is an input or an output agent trading in raw material or final
       product).


   .. py:method:: propose(negotiator_id, state)

      Proposes an offer to one of the partners.

      :param negotiator_id: ID of the negotiator (and partner)
      :param state: Mechanism state including current step

      :returns: an outcome to offer.



   .. py:method:: respond(negotiator_id, state, source=None)

      Responds to an offer from one of the partners.

      :param negotiator_id: ID of the negotiator (and partner)
      :param state: Mechanism state including current step

      :returns: A response type which can either be reject, accept, or end negotiation.

      Remarks:
          default behavior is to accept only if the current offer is the same
          or has a higher utility compared with what the agent would have
          proposed in the given state and reject otherwise




.. py:class:: Placeholder(*args, **kwargs)

   Bases: :py:obj:`scml.oneshot.policy.OneShotPolicy`


   An agent that always raises an exception if called to negotiate. It is useful as a placeholder (for example for RL and MARL exposition)


   .. py:method:: act(state)

      The main policy. Generates an action given a state