API Reference
=============

This page contains the complete API reference for gym-tl-tools.

Core Classes
------------

.. automodule:: gym_tl_tools
   :members:

TLObservationReward Wrapper
---------------------------

.. autoclass:: gym_tl_tools.TLObservationReward
   :members:
   :inherited-members:
   :show-inheritance:

Variable Value Generator
------------------------

.. autoclass:: gym_tl_tools.BaseVarValueInfoGenerator
   :members:
   :show-inheritance:

Configuration Classes
---------------------

.. autoclass:: gym_tl_tools.TLObservationRewardConfig
   :members:
   :show-inheritance:

.. autoclass:: gym_tl_tools.RewardConfig
   :members:
   :show-inheritance:

Automaton and Predicates
------------------------

.. autoclass:: gym_tl_tools.Automaton
   :members:
   :show-inheritance:

.. autoclass:: gym_tl_tools.Predicate
   :members:
   :show-inheritance:

Parser
------

.. autoclass:: gym_tl_tools.Parser
   :members:
   :show-inheritance:

.. autoclass:: gym_tl_tools.ParserSymbol
   :members:
   :show-inheritance:

Utility Functions
-----------------

.. autofunction:: gym_tl_tools.replace_special_characters

Type Definitions
----------------

.. autodata:: gym_tl_tools.RewardConfigDict