budget
======

.. py:module:: budget

.. autoapi-nested-parse::

   Budget class for agents.

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   budget.Budget


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

.. py:class:: Budget

   
   Specifications for generating a random budget sample.

   This is used for assigning the agent's budget in base tokens.
   Wei in the variables below refers to the smallest unit of base, not to ETH.















   ..
       !! processed by numpydoc !!

   .. py:attribute:: mean_wei
      :type:  int


   .. py:attribute:: std_wei
      :type:  int


   .. py:attribute:: min_wei
      :type:  int


   .. py:attribute:: max_wei
      :type:  int


   .. py:method:: sample_budget(rng: numpy.random.Generator) -> fixedpointmath.FixedPoint

      
      Return a sample from a clipped normal distribution.

      Sample from normal distribution with mean of mean_wei and standard deviation of std_wei.
      Then clip to between a minimum of min_wei and a maximum of max_wei.

      :param rng: The numpy Generator provides access to a wide range of distributions, and stores the random state.
      :type rng: `Generator <https://numpy.org/doc/stable/reference/random/generator.html>`_

      :returns: A sample from a clipped random normal distribution according to the parameters defined at construction
      :rtype: FixedPoint















      ..
          !! processed by numpydoc !!