scml.scml2020.agents.reactive
=============================

.. py:module:: scml.scml2020.agents.reactive

.. autoapi-nested-parse::

   Implements the `DecentralizingAgent` which creates ony buy and one sell controller for each time-step and relinquishes
   control of negotiations to buy/sell the required number of items of its input/output product.



Classes
-------

.. autoapisummary::

   scml.scml2020.agents.reactive.ReactiveAgent
   scml.scml2020.agents.reactive.MarketAwareReactiveAgent


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

.. py:class:: ReactiveAgent(*args, negotiator_type: Union[negmas.SAONegotiator, str] = AspirationNegotiator, negotiator_params: Optional[Dict[str, Any]] = None, **kwargs)

   Bases: :py:obj:`scml.scml2020.components.StepNegotiationManager`, :py:obj:`scml.scml2020.components.trading.ReactiveTradingStrategy`, :py:obj:`scml.scml2020.components.production.TradeDrivenProductionStrategy`, :py:obj:`scml.scml2020.components.FixedTradePredictionStrategy`, :py:obj:`scml.scml2020.world.SCML2020Agent`


   A negotiation manager that controls a controller and another for selling for every timestep

   :param negotiator_type: The negotiator type to use to manage all negotiations
   :param negotiator_params: Paramters of the negotiator

   Provides:
       - `all_negotiations_concluded`

   Requires:
       - `acceptable_unit_price`
       - `target_quantity`
       - OPTIONALLY `target_quantities`

   Hooks Into:
       - `init`
       - `respond_to_negotiation_request`

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.


   .. py:method:: acceptable_unit_price(step: int, sell: bool) -> int

      Returns the maximum/minimum acceptable unit price for buying/selling at the given time-step

      :param step: Simulation step
      :param sell: Sell or buy



   .. py:method:: target_quantity(step: int, sell: bool) -> int

      Returns the target quantity to sell/buy at a given time-step

      :param step: Simulation step
      :param sell: Sell or buy



   .. py:method:: target_quantities(steps: Tuple[int, int], sell: bool) -> numpy.ndarray

      Implemented for speed but not really required



.. py:class:: MarketAwareReactiveAgent(*args, buying_margin=None, selling_margin=None, min_price_margin=0.5, max_price_margin=0.5, **kwargs)

   Bases: :py:obj:`scml.scml2020.components.signing.KeepOnlyGoodPrices`, :py:obj:`ReactiveAgent`


   Signs all contracts that have good prices

   Overrides:
       - `sign_all_contracts`

   .. attribute:: - buying_margin

      The margin from the catalog price to allow for buying. The agent will never buy at a price
      higher than the catalog price by more than this margin (relative to catalog price).

   .. attribute:: - selling_margin

      The margin from the catalog price to allow for selling. The agent will never sell at a price
      lower than the catalog price by more than this margin (relative to catalog price).

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.