Code reference
--------------

Core
^^^^

.. autoclass :: metropc.ViewStage

.. autoclass :: metropc.ViewOutput

.. autoclass :: metropc.ContextStage

.. autoclass :: metropc.core.Context
   :members: require_version, require_feature, set_view_docs, increase_view_counts

   .. attribute :: stage

      :type: metropc.ContextStage

      Stage at which this context object is created.


Builtin view implementations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. class :: metropc.builtin.HistogramView

   Delegates to :class:`metropc.builtin.VectorHistogramView` or :class:`metropc.builtin.MatrixHistogramView` depending on output type.

.. autoclass :: metropc.builtin.VectorHistogramView
   :members: __init__

.. autoclass :: metropc.builtin.MatrixHistogramView
   :members: __init__

.. autoclass :: metropc.builtin.HistogramView.BinnedAxis
   :members: __init__

.. autoclass :: metropc.builtin.BinReduceView
   :members: __init__

.. autoclass :: metropc.builtin.VectorBinReduceView
   :members: __init__

.. autoclass :: metropc.builtin.MatrixBinReduceView
   :members: __init__

.. autoclass :: metropc.builtin.LocalAverageView
   :members: __init__

.. autoclass :: metropc.builtin.GlobalAverageView
   :members: __init__

.. autoclass :: metropc.builtin.MovingAverageView
   :members: __init__

.. autoclass :: metropc.builtin.ExtremumView
   :members: __init__

.. autoclass :: metropc.builtin.StepAverageView
   :members: __init__

.. autoclass :: metropc.builtin.StepStackedView
   :members: __init__

.. _frontend_api:

Frontend API
^^^^^^^^^^^^

.. autoclass :: metropc.frontend.Context
   :members: __init__, to_dict, add_path_symbols, add_parameters

.. autoclass :: metropc.frontend.StageGroup
   :members: create_pipeline

.. autofunction :: metropc.frontend.encode_protocol
.. autofunction :: metropc.frontend.decode_protocol

.. autoclass :: metropc.frontend.EventBuffer
   :members: by_strategy, __init__, clear, __len__, add_input, ready_events
   :undoc-members:

.. autoclass :: metropc.stage.StageRunner
   :members: __init__, start, join, join_or_kill

.. autoclass :: metropc.stage.ThreadRunner
   :show-inheritance:

.. autoclass :: metropc.stage.ProcessRunner
   :show-inheritance:

.. autoclass :: metropc.stage.PoolContext
.. autoclass :: metropc.stage.ReduceContext

.. _client_api:

Client API
^^^^^^^^^^

.. function :: metropc.client.decode_protocol

   Identical to :func:`metropc.protocol.decode_protocol`, but automatically decodes ``b'index'`` opcodes into :class:`metropc.client.IndexEntry` objects.

.. autofunction :: metropc.protocol.decode_protocol
   :noindex:

.. autoclass :: metropc.client.IndexEntry

.. autoclass :: metropc.client.IndexViewEntry


ZeroMQ Protocol
^^^^^^^^^^^^^^^

.. automodule :: metropc.protocol
   :members: encode_protocol, decode_protocol