==========
Simulators
==========

Continuous, discrete and hybrid simulation.

.. cpp:namespace:: hysj

.. cpp:namespace-push:: simulators

In namespace :cpp:any:`simulators`:

Continuous
==========

.. cpp:namespace-push:: continuous

In namespace :cpp:any:`continuous`:
   
Problem
-------

:cpp:include:`#include<hysj/simulators/continuous/problem.hpp>`

.. cpp:struct:: variables

   .. cpp:member:: mathematics::symbol_id independent
   .. cpp:member:: std::vector<mathematics::expression_ids> dependent

   |
   
.. cpp:struct:: problem

   .. cpp:member:: mathematics::program program
   .. cpp:member:: continuous::variables variables
   .. cpp:member:: mathematics::equation_ids equations
   .. cpp:member:: mathematics::logical_expression_ids constraints

   |

.. cpp:struct:: valuation

   .. cpp:member:: real independent
   .. cpp:member:: std::vector<std::vector<real>> dependen

   |

.. cpp:struct:: root

   .. cpp:member:: natural index
   .. cpp:member:: bool positive

   |

Constraint Automaton
--------------------

:cpp:include:`#include<hysj/simulators/continuous/constraint_automaton.hpp>`
     
.. cpp:struct:: constraint_automaton

   .. cpp:type:: state
   .. cpp:type:: symbol
   .. cpp:type:: symbols
   .. cpp:type:: graph
   .. cpp:member:: mathematics::equation_ids equations
   .. cpp:member:: std::vector<graph> graphs
   
   |

.. cpp:function:: constraint_automaton make_constraint_automaton(const problem &)

   |

.. cpp:function:: constraint_automaton::state start(const constraint_automaton &,const constraint_automaton::symbols &)

   |

.. cpp:function:: constraint_automaton::state advance(const constraint_automaton &,const constraint_automaton::state &,const constraint_automaton::symbol &)

   |

.. cpp:function:: bool is_active(const constraint_automaton &,const constraint_automaton::state &)

   |

.. cpp:function:: coroutines::builtin::generator<natural> active(const constraint_automaton &,const constraint_automaton::state &);

   |

Solution
--------

:cpp:include:`#include<hysj/simulators/continuous.hpp>`

.. cpp:enum-class:: event

   .. rest-script::

      from hysj import simulators

      for e in simulators.continuous.Event.__members__.values():
        print(f'.. cpp:enumerator:: {e.name}')

   |

.. cpp:struct:: step

   .. cpp:enum-class:: mode_tag

      .. rest-script::

	 from hysj import simulators

         for e in simulators.continuous.Step.ModeTag.__members__.values():
           print(f'.. cpp:enumerator:: {e.name}')

   .. cpp:member:: mode_tag mode
   .. cpp:member:: real delta

   |

.. cpp:struct:: tolerance

   .. cpp:type:: absolute_type = std::variant<real,std::vector<real>>
   .. cpp:member:: real relative
   .. cpp:member:: absolute_type absolute

   |

.. cpp:struct:: config

   .. cpp:member:: continuous::tolerance tolerance
   .. cpp:member:: continuous::step step
   .. cpp:member:: std::optional<real> stop

   |

.. cpp:struct:: state

   .. cpp:member:: continuous::valuation valuation
   .. cpp:member:: continuous::root root
   .. cpp:member:: std::vector<graphs::builtin::vertex_id> constraints
   .. cpp:member:: std::vector<natural> active_constraints

   |

.. cpp:struct:: solution

   .. cpp:function:: constraint_automaton  &constraints()const
   .. cpp:function:: continuous::state  &state()const
   .. cpp:function:: continuous::config &config()const
   .. cpp:function:: std::optional<event> operator()()const

   |

.. cpp:function:: solution make_solution(problem,valuation,config)

   |

.. cpp:namespace-pop::

Discrete
========

:cpp:include:`#include<hysj/simulators/discrete.hpp>`

.. cpp:namespace-push:: discrete

In namespace :cpp:any:`discrete`:

Automaton
---------

:cpp:include:`#include<hysj/simulators/discrete/automaton.hpp>`

.. cpp:struct:: partial_automaton

   .. cpp:type:: graph_type = graphs::builtin::bincidence_graph<location,symbol>
   .. cpp:type:: location_map_type = std::unordered_map<location,graphs::builtin::vertex_id,location_hasher>
   .. cpp:member:: graph_type graph
   .. cpp:member:: location_map_type location_map

   |

Problem
-------

:cpp:include:`#include<hysj/simulators/discrete/problem.hpp>`

.. cpp:type:: variable = natural
.. cpp:type:: variables = std::vector<natural>
.. cpp:type:: value = integer
.. cpp:type:: location  = std::vector<value>
.. cpp:type:: locations = std::vector<location>

   |

.. cpp:struct:: problem

   .. cpp:type:: make_symbols_type = std::function<symbols(const location &)>
   .. cpp:type:: make_target_type  = std::function<location(const location &,const symbol &)>
   .. cpp:type:: is_immediate_type = std::function<bool(const location &,const symbol &)>
   .. cpp:member:: make_symbols_type make_symbols
   .. cpp:member:: make_target_type make_target
   .. cpp:member:: is_immediate_type is_immediate

   |

Solution
--------

:cpp:include:`#include<hysj/simulators/discrete.hpp>`

.. cpp:enum-class:: event

   .. rest-script::

     from hysj import simulators

     for e in simulators.discrete.Event.__members__.values():
       print(f'.. cpp:enumerator:: {e.name}')

   |

.. cpp:struct:: config

   |

.. cpp:struct:: state

   .. cpp:member:: partial_automaton automaton
   .. cpp:member:: graphs::builtin::vertex_id vertex
   .. cpp:member:: std::optional<natural> edge

   |

.. cpp:struct:: solution

   .. cpp:function:: discrete::state  &state()const
   .. cpp:function:: discrete::config &config()const
   .. cpp:function:: std::optional<event> operator()()const

   |

.. cpp:function:: solution make_solution(problem,location,config)

   |

.. cpp:namespace-pop::

Hybrid
======

:cpp:include:`#include<hysj/simulators/hybrid.hpp>`

In namespace :cpp:any:`hybrid`:

.. cpp:namespace-push:: hybrid

.. cpp:struct:: config

   .. cpp:member:: discrete::config discrete
   .. cpp:member:: continuous::config continuous

   |

.. cpp:struct:: valuation

   .. cpp:member:: discrete::config discrete
   .. cpp:member:: continuous::config continuous

   |

.. cpp:type:: action  = std::vector<std::pair<continuous::variable_index,mathematics::expression_id>>;
	      actions = std::vector<action>

   |

.. cpp:struct:: continuous_problem
                
   .. cpp:type:: make_equations_type =				\
      		   std::function<mathematics::equation_ids(	\
  		     mathematics::program &,			\
		     const discrete::location &)>
   .. cpp:type:: make_constraint_type =                                 \
                   std::function<mathematics::logical_expression_id(    \
                     mathematics::program &,                            \
                     const discrete::location &,                        \
		     const discrete::symbol &)>

   .. cpp:member:: continuous::variables variables
   .. cpp:member:: make_equations_type make_equations
   .. cpp:member:: make_constraint_type make_constraint

   |

.. cpp:struct:: problem

   .. cpp:type:: make_action_type =                             \
                   std::function<action(mathematics::program &, \
                     const discrete::location &,                \
                     const discrete::symbol &)>

   .. cpp:member:: mathematics::program program
   .. cpp:member:: discrete::problem discrete
   .. cpp:member:: continuous_problem continuous
   .. cpp:member:: make_action_type make_action

   |

.. cpp:type:: event = std::variant<continuous::event,discrete::event>

.. cpp:struct:: solution

   .. cpp:function:: discrete::solution  &discrete()const
   .. cpp:function:: continuous::solution &continuous()const
   .. cpp:function:: std::optional<event> operator()()const

   |

.. cpp:function:: solution make_solution(problem,location,config)

   |

.. cpp:namespace-pop::

.. cpp:namespace-pop::