.. _regular_formula.h:
  
mcrl2/modal_formula/regular_formula.h
===============================================================================

Include file: 

.. code-block:: c++ 

   #include "mcrl2/modal_formula/regular_formula.h"

Add your file description here. 




Classes
-------

* :cpp:class:`mcrl2::regular_formulas::alt`

* :cpp:class:`mcrl2::regular_formulas::regular_formula`

* :cpp:class:`mcrl2::regular_formulas::seq`

* :cpp:class:`mcrl2::regular_formulas::trans`

* :cpp:class:`mcrl2::regular_formulas::trans_or_nil`

* :cpp:class:`mcrl2::regular_formulas::untyped_regular_formula`

Typedefs
-------------------------------------------------------------------------------

.. cpp:type:: mcrl2::regular_formulas::regular_formula_list

  typedef for :cpp:type:`atermpp::term_list\< regular_formula >`
  
  list of regular_formulas

  

.. cpp:type:: mcrl2::regular_formulas::regular_formula_vector

  typedef for :cpp:type:`std::vector\< regular_formula >`
  
  vector of regular_formulas

  

Functions
-------------------------------------------------------------------------------

.. cpp:function:: bool is_alt(const atermpp::aterm_appl &x)
  
  Test for a alt expression. 

  
  
  **Parameters:**

  * **x** A term 


      
  **Returns:** True if x is a alt expression 

.. cpp:function:: bool mcrl2::regular_formulas::is_regular_formula(const atermpp::aterm_appl &x)
  
  Test for a regular_formula expression. 

  
  
  **Parameters:**

  * **x** A term 


      
  **Returns:** True if x is a regular_formula expression 

.. cpp:function:: bool is_seq(const atermpp::aterm_appl &x)
  
  Test for a seq expression. 

  
  
  **Parameters:**

  * **x** A term 


      
  **Returns:** True if x is a seq expression 

.. cpp:function:: bool is_trans(const atermpp::aterm_appl &x)
  
  Test for a trans expression. 

  
  
  **Parameters:**

  * **x** A term 


      
  **Returns:** True if x is a trans expression 

.. cpp:function:: bool is_trans_or_nil(const atermpp::aterm_appl &x)
  
  Test for a trans_or_nil expression. 

  
  
  **Parameters:**

  * **x** A term 


      
  **Returns:** True if x is a trans_or_nil expression 

.. cpp:function:: bool is_untyped_regular_formula(const atermpp::aterm_appl &x)
  
  Test for a untyped_regular_formula expression. 

  
  
  **Parameters:**

  * **x** A term 


      
  **Returns:** True if x is a untyped_regular_formula expression 

.. cpp:function:: std::ostream& mcrl2::regular_formulas::operator<<(std::ostream &out, const regular_formula &x)
  
  Outputs the object to a stream. 

  
  
  **Parameters:**

  * **out** An output stream 

  * **x** Object x 


      
  **Returns:** The output stream 

.. cpp:function:: std::ostream& mcrl2::regular_formulas::operator<<(std::ostream &out, const seq &x)
  
  Outputs the object to a stream. 

  
  
  **Parameters:**

  * **out** An output stream 

  * **x** Object x 


      
  **Returns:** The output stream 

.. cpp:function:: std::ostream& mcrl2::regular_formulas::operator<<(std::ostream &out, const alt &x)
  
  Outputs the object to a stream. 

  
  
  **Parameters:**

  * **out** An output stream 

  * **x** Object x 


      
  **Returns:** The output stream 

.. cpp:function:: std::ostream& mcrl2::regular_formulas::operator<<(std::ostream &out, const trans &x)
  
  Outputs the object to a stream. 

  
  
  **Parameters:**

  * **out** An output stream 

  * **x** Object x 


      
  **Returns:** The output stream 

.. cpp:function:: std::ostream& mcrl2::regular_formulas::operator<<(std::ostream &out, const trans_or_nil &x)
  
  Outputs the object to a stream. 

  
  
  **Parameters:**

  * **out** An output stream 

  * **x** Object x 


      
  **Returns:** The output stream 

.. cpp:function:: std::ostream& mcrl2::regular_formulas::operator<<(std::ostream &out, const untyped_regular_formula &x)
  
  Outputs the object to a stream. 

  
  
  **Parameters:**

  * **out** An output stream 

  * **x** Object x 


      
  **Returns:** The output stream 

.. cpp:function:: std::string pp(const regular_formula &x)
  
  

  

.. cpp:function:: std::string pp(const seq &x)
  
  

  

.. cpp:function:: std::string pp(const alt &x)
  
  

  

.. cpp:function:: std::string pp(const trans &x)
  
  

  

.. cpp:function:: std::string pp(const trans_or_nil &x)
  
  

  

.. cpp:function:: std::string pp(const untyped_regular_formula &x)
  
  

  

.. cpp:function:: void mcrl2::regular_formulas::swap(regular_formula &t1, regular_formula &t2)
  
  swap overload 

  

.. cpp:function:: void mcrl2::regular_formulas::swap(seq &t1, seq &t2)
  
  swap overload 

  

.. cpp:function:: void mcrl2::regular_formulas::swap(alt &t1, alt &t2)
  
  swap overload 

  

.. cpp:function:: void mcrl2::regular_formulas::swap(trans &t1, trans &t2)
  
  swap overload 

  

.. cpp:function:: void mcrl2::regular_formulas::swap(trans_or_nil &t1, trans_or_nil &t2)
  
  swap overload 

  

.. cpp:function:: void mcrl2::regular_formulas::swap(untyped_regular_formula &t1, untyped_regular_formula &t2)
  
  swap overload