refine_plan.models.policy
=========================

.. py:module:: refine_plan.models.policy

.. autoapi-nested-parse::

   Class for deterministic memoryless policies.

   Author: Charlie Street
   Owner: Charlie Street



Classes
-------

.. autoapisummary::

   refine_plan.models.policy.Policy


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

.. py:class:: Policy(state_action_dict, value_dict=None, policy_file=None)

   Bases: :py:obj:`object`


   Data class for deterministic memoryless policies.

   .. attribute:: _state_action_dict

      A dictionary from states to actions

   .. attribute:: _value_dict

      A dictionary from states to values under that policy


   .. py:method:: get_action(state)

      Return the policy action for a given state.

      :param state: The state we want an action for

      :returns: The policy action



   .. py:method:: get_value(state)

      Return the value at a given state.

      :param state: The state we want to retrieve the value for

      :returns: The value at state

      :raises no_value_dict_exception: Raised if there is no value dictionary



   .. py:method:: write_policy(out_file)

      Write a policy with all state factor information to a YAML file.

      :param out_file: The yaml file to write to