U
    +¿ifû  ã                   @   sÀ   d Z ddlmZ ddlmZ ef eŽZeedœdd„ZdZedƒ 	d	d
d¡Z
edƒ 	d	d
d¡Zedƒ 	d	d
d¡Zedƒ 	d	d
d¡Zedƒ 	d	d
d¡Zedƒ 	d	d
d¡ZdZdeedœdd„ZdS )z<Any shareable docstring components for rolling/expanding/ewmé    )Údedent)Ú_shared_docs)ÚheaderÚreturnc                 C   s   d  | dt| ƒ f¡d S )zCreate numpydoc section headerÚ
ú-)ÚjoinÚlen)r   © r
   úI/home/mars/bis/venv/lib/python3.8/site-packages/pandas/core/window/doc.pyÚcreate_section_header	   s    r   z;
Calculate the {window_method} {aggregation_description}.

zp
    Series or DataFrame
        Return type is the same as the original object with ``np.float64`` dtype.

    r   Ú é   a6  
    pandas.Series.{window_method} : Calling {window_method} with Series data.
    pandas.DataFrame.{window_method} : Calling {window_method} with DataFrames.
    pandas.Series.{agg_method} : Aggregating {agg_method} for Series.
    pandas.DataFrame.{agg_method} : Aggregating {agg_method} for DataFrame.

    z[
    *args
        For NumPy compatibility and will not have an effect on the result.

    z^
    **kwargs
        For NumPy compatibility and will not have an effect on the result.

    z^
    **kwargs
        Keyword arguments to configure the ``SciPy`` weighted window type.

    a˜  
    func : function
        Must produce a single value from an ndarray input if ``raw=True``
        or a single value from a Series if ``raw=False``. Can also accept a
        Numba JIT function with ``engine='numba'`` specified.

        .. versionchanged:: 1.0.0

    raw : bool, default False
        * ``False`` : passes each row or column as a Series to the
          function.
        * ``True`` : the passed function will receive ndarray
          objects instead.
          If you are just applying a NumPy reduction function this will
          achieve much better performance.

    engine : str, default None
        * ``'cython'`` : Runs rolling apply through C-extensions from cython.
        * ``'numba'`` : Runs rolling apply through JIT compiled code from numba.
          Only available when ``raw`` is set to ``True``.
        * ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``

          .. versionadded:: 1.0.0

    engine_kwargs : dict, default None
        * For ``'cython'`` engine, there are no accepted ``engine_kwargs``
        * For ``'numba'`` engine, the engine can accept ``nopython``, ``nogil``
          and ``parallel`` dictionary keys. The values must either be ``True`` or
          ``False``. The default ``engine_kwargs`` for the ``'numba'`` engine is
          ``{{'nopython': True, 'nogil': False, 'parallel': False}}`` and will be
          applied to both the ``func`` and the ``apply`` rolling aggregation.

          .. versionadded:: 1.0.0

    args : tuple, default None
        Positional arguments to be passed into func.

    kwargs : dict, default None
        Keyword arguments to be passed into func.

    zSee :ref:`window.numba_engine` and :ref:`enhancingperf.numba` for extended documentation and performance considerations for the Numba engine.

ú1.3)Úversionr   c                 C   s   t dƒ ddd¡ d| ¡S )Na  
    engine : str, default None
        * ``'cython'`` : Runs the operation through C-extensions from cython.
        * ``'numba'`` : Runs the operation through JIT compiled code from numba.
        * ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``

          .. versionadded:: {version}.0

    engine_kwargs : dict, default None
        * For ``'cython'`` engine, there are no accepted ``engine_kwargs``
        * For ``'numba'`` engine, the engine can accept ``nopython``, ``nogil``
          and ``parallel`` dictionary keys. The values must either be ``True`` or
          ``False``. The default ``engine_kwargs`` for the ``'numba'`` engine is
          ``{{'nopython': True, 'nogil': False, 'parallel': False}}``

          .. versionadded:: {version}.0

    r   r   r   z	{version})r   Úreplace)r   r
   r
   r   Úwindow_agg_numba_parametersf   s    ÿ  í ìÿr   N)r   )Ú__doc__Útextwrapr   Zpandas.core.shared_docsr   ÚdictÚstrr   Ztemplate_headerr   Ztemplate_returnsZtemplate_see_alsoZargs_compatZkwargs_compatZkwargs_scipyZwindow_apply_parametersZnumba_notesr   r
   r
   r
   r   Ú<module>   sd   
ÿ  ûÿ  ù	ÿ  ûÿ  ûÿ  ûÿ)  ×,ÿ