:mod:`dfba.jit`
===============

.. py:module:: dfba.jit

.. autoapi-nested-parse::

   JIT compilation of functionlib.cpp.

   Adapted from
   <https://github.com/jakeret/hope>. Copyright (c) 2013 ETH Zurich, Institute
   of Astronomy, Lukas Gamper <lukas.gamper@usystems.ch>.



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

Classes
~~~~~~~

.. autoapisummary::

   dfba.jit.BuildExtWithoutPlatformSuffix



Functions
~~~~~~~~~

.. autoapisummary::

   dfba.jit.get_ext_filename_without_platform_suffix
   dfba.jit.get_cxxflags
   dfba.jit.compile



Attributes
~~~~~~~~~~

.. autoapisummary::

   dfba.jit.logger
   dfba.jit.CXX_FLAGS


.. data:: logger
   

   

.. data:: CXX_FLAGS
   

   

.. exception:: UnsupportedCompilerException


   Bases: :py:obj:`Exception`

   Raise exceptions on unsuported compilers.


.. class:: BuildExtWithoutPlatformSuffix(dist)


   Bases: :py:obj:`setuptools.command.build_ext.build_ext`

   Class for building library functionlib WithoutPlatformSuffix.

   .. method:: get_ext_filename(self, ext_name: str) -> str

      Relies onf ext_name.



.. function:: get_ext_filename_without_platform_suffix(filename: str) -> str

   File name without platform suffix.

   :returns: Name of shared library without platform suffix.
   :rtype: filename


.. function:: get_cxxflags() -> List[str]

   CXX FLAGS.

   JIT compilation of functionlib.cpp adapted from
   <https://github.com/jakeret/hope>. Copyright (c) 2013 ETH Zurich, Institute
   of Astronomy, Lukas Gamper <lukas.gamper@usystems.ch>

   :returns: The appropriate CXX FLAGS for compilation of functionlib.cpp on
             supported platform. Requires compilation with c++11 features enabled.
   :rtype: flags


.. function:: compile(directory: str) -> str

   Compile library.

   JIT compilation of functionlib.cpp adapted from
   <https://github.com/jakeret/hope>. Copyright (c) 2013 ETH Zurich, Institute
   of Astronomy, Lukas Gamper <lukas.gamper@usystems.ch>

   :param directory: Path to temporary directory containing library.
   :type directory: string