.. _l-functions:

Functions
=========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                    | class parent | truncated documentation                                                                                                                                                                                                                        |
+=============================================================================================+==============+================================================================================================================================================================================================================================================+
| :func:`_setup_hook <sparkouille._setup_hook>`                                               |              | If this function is added to the module, the help automation and unit tests call it first before anything goes on ...                                                                                                                          |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <sparkouille.check>`                                                           |              | Checks the library is working. It raises an exception. If you want to disable the logs:                                                                                                                                                        |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`combiner <sparkouille.fctmr.simplefctmr.combiner>`                                   |              | Joins (or combines) two generators. The function is written based on two reducers. The function is more efficient ...                                                                                                                          |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_array_numba <sparkouille.fctmr.fast_parallel_fctmr.create_array_numba>`       |              | Creates an array of size nb knowing its signature.                                                                                                                                                                                             |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`fast_parallel_mapper <sparkouille.fctmr.fast_parallel_fctmr.fast_parallel_mapper>`   |              | Parallelizes a mapper based on :epkg:`numba` and more specifically `Automatic parallelization with @jit <https://numba.pydata.org/ numba-doc/dev/user/parallel.html>`_. ...                                                                    |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`ffilter <sparkouille.fctmr.simplefctmr.ffilter>`                                     |              | Filters out elements from a generator.                                                                                                                                                                                                         |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`mapper <sparkouille.fctmr.simplefctmr.mapper>`                                       |              | Applies function *fct* to a generator.                                                                                                                                                                                                         |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`pyparallel_mapper <sparkouille.fctmr.pyparallel_fctmr.pyparallel_mapper>`            |              | Applies function *fct* to a generator. Relies on *ThreadPool*.                                                                                                                                                                                 |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`reducer <sparkouille.fctmr.simplefctmr.reducer>`                                     |              | Implements a reducer.                                                                                                                                                                                                                          |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`table_mortalite_euro_stat <sparkouille.datasets.eurostat.table_mortalite_euro_stat>` |              | This function retrieves mortality table from `EuroStat <http://ec.europa.eu/eurostat/fr>`_ through `table de mortalité <http://www.data-publica.com/ opendata/7098--population-et-conditions-sociales-table-de-mortalite-de-1960-a-2010>`_ ... |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`take <sparkouille.fctmr.simplefctmr.take>`                                           |              | Skips and takes elements from a generator.                                                                                                                                                                                                     |
+---------------------------------------------------------------------------------------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+