:py:mod:`pycmtensor.expressions`
================================

.. py:module:: pycmtensor.expressions

.. autoapi-nested-parse::

   PyCMTensor expressions module



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

.. py:class:: ExpressionParser

   Base class for the Expression Parser object

   .. py:method:: parse(expression)

      Returns a list of str words found in expression

      :param expression: The symbolic Tensor object to parse



.. py:class:: Expressions

   Base class for expression objects


.. py:class:: Beta(name, value=0.0, lowerbound=None, upperbound=None, status=0)

   Bases: :py:obj:`Expressions`

   Class object for Beta parameters

   .. attribute:: name

      Name of the Beta

      :type: str

   .. attribute:: init_value

      The inital value of the Beta when created

      :type: float

   .. attribute:: status

      The status of the Beta. Not modifiable

      :type: int

   .. attribute:: shared_var

      The shared variable object
      of the Beta parameter to be updated on. Can be accessed with a call function

      :type: :class:`aet.TensorSharedVariable`

   Constructor for Beta class object

   :param name: Name of the Beta class object
   :type name: str
   :param value: Initial starting value. Defaults to ``0``
   :type value: float
   :param lowerbound: lowerbound value. Defaults to ``None``
   :type lowerbound: float
   :param upperbound: upperbound value. Defaults to ``None``
   :type upperbound: float
   :param status: Whether to estimate (0) this Beta expression or not (1).
   :type status: int

   .. py:method:: name()
      :property:


   .. py:method:: init_value()
      :property:


   .. py:method:: status()
      :property:


   .. py:method:: get_value()

      Returns the numpy representation of the Beta value


   .. py:method:: reset_value()

      Resets the value of the shared variable to the initial value



.. py:class:: Weights(name, size, status, random_init=True)

   Bases: :py:obj:`Expressions`

   Base class for expression objects

   .. py:method:: reset_value()

      Resets the value of the shared variable to the initial value


   .. py:method:: get_value()

      Returns the numpy representation of the Weights