pyxla
=====

.. module:: pyxla

The core functions of the library. These function comprise xLA features.

.. autofunction:: pyxla.distr_f
    
    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, distr_f
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('ackley8d_F1_V0', test=True)
        >>> _, plot = distr_f(sample)

.. autofunction:: pyxla.distr_v

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, distr_v
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = distr_v(sample)

.. autofunction:: pyxla.distr_Par

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, distr_Par
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = distr_Par(sample)

.. autofunction:: pyxla.distr_Deb

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, distr_Deb
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = distr_Deb(sample)

.. autofunction:: pyxla.corr

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, corr
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = corr(sample)

.. autofunction:: pyxla.corr_ranks

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, corr_ranks
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = corr_ranks(sample)

.. autofunction:: pyxla.fdc

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, fdc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('sphere', test=True)
        >>> _, plot = fdc(sample)

.. autofunction:: pyxla.vdc

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, vdc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = vdc(sample)

.. autofunction:: pyxla.rdc

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, rdc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = rdc(sample)

.. autofunction:: pyxla.pdc
    
    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, pdc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('cec2010_c01_2d_F1_V2', test=True)
        >>> _, plot = pdc(sample)

.. autofunction:: pyxla.nfc

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, nfc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('nk_n14_k2_id5_F1_V1', test=True)
        >>> _, plot = nfc(sample)

.. autofunction:: pyxla.nvc

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, nvc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('nk_n14_k2_id5_F1_V1', test=True)
        >>> _, plot = nvc(sample)

.. autofunction:: pyxla.nrc

    .. plot::

        >>> import matplotlib
        >>> from pyxla import util, nrc
        >>> import os
        >>> os.chdir('../../')
        >>> sample = util.load_sample('nk_n14_k2_id5_F1_V1', test=True)
        >>> _, plot = nrc(sample)

.. autofunction:: pyxla.ncf

    .. plot::

        >>> import matplotlib
        >>> import os
        >>> from pyxla import util, ncf
        >>> os.chdir('../../')
        >>> sample = util.load_sample('nk_n14_k2_id5_F1_V1', test=True)
        >>> _, plot = ncf(sample)

.. autofunction:: pyxla.disp_best

    .. plot::

        >>> import matplotlib
        >>> import os
        >>> from pyxla import util, disp_best
        >>> os.chdir('../../')
        >>> sample = util.load_sample('sphere', test=True)
        >>> _, plot = disp_best(sample)

.. autofunction:: pyxla.X_imp

    .. plot::

        >>> import matplotlib
        >>> import os
        >>> from pyxla import util, X_imp
        >>> os.chdir('../../')
        >>> sample = util.load_sample('nk_n14_k2_id5_F1_V1', test=True)
        >>> _, _, plot = X_imp(sample, alpha=0.001)
    
**References**

.. bibliography::
    :filter: docname in docnames