U
    sVc                     @  s  U d Z ddlmZ ddlZddlmZmZmZmZm	Z	m
Z
mZmZmZ ddlZddlZddlm  mZ ddlmZmZmZmZmZmZ ddlmZ ddlmZ ddl m!Z! dd	l"m#Z#m$Z$ dd
l%m&Z& ddl'm(Z(m)Z)m*Z*m+Z+m,Z, ddl-m.Z.m/Z/m0Z0 ddl1m2Z2m3Z3 ddl4m5Z5m6Z6m7Z7 ddl8m9Z9 ddl:m;Z;m<Z<m=Z= ddl>m?Z? ddl@mAZA ddlBmCZCmDZDmEZE erddlmFZFmGZGmHZH ddlImJZJmKZK i ZLdeMd< dddddZNe
dddZOG dd de9ZPG dd  d ZQG d!d" d"ee ZRG d#d de?ZSdS )$z.
Base and utility classes for pandas objects.
    )annotationsN)	TYPE_CHECKINGAnyGenericHashableLiteralTypeVarcastfinaloverload)	ArrayLikeDtypeObj
IndexLabelNDFrameTShapenpt)PYPY)functionAbstractMethodError)cache_readonlydoc)find_stack_level)is_categorical_dtypeis_dict_likeis_extension_array_dtypeis_object_dtype	is_scalar)ABCDataFrameABCIndex	ABCSeries)isnaremove_na_arraylike)
algorithmsnanopsops)DirNamesMixin)
duplicatedunique1dvalue_counts)OpsMixin)ExtensionArray)!create_series_with_explicit_dtypeensure_wrapped_if_datetimelikeextract_array)NumpySorterNumpyValueArrayLikeScalarLike_co)CategoricalSerieszdict[str, str]_shared_docsIndexOpsMixin )klassZinplaceuniquer'   _T)boundc                      s\   e Zd ZU dZded< edd Zdddd	ZddddddZdd fddZ	  Z
S )PandasObjectz/
    Baseclass for various pandas objects.
    zdict[str, Any]_cachec                 C  s   t | S )zJ
        Class constructor (for this class it's just `__class__`.
        )typeself r@   4/tmp/pip-unpacked-wheel-xj8nt62q/pandas/core/base.py_constructorn   s    zPandasObject._constructorstrreturnc                 C  s
   t | S )zI
        Return a string representation for a particular object.
        )object__repr__r>   r@   r@   rA   rG   u   s    zPandasObject.__repr__Nz
str | NoneNonekeyrE   c                 C  s4   t | dsdS |dkr"| j  n| j|d dS )zV
        Reset cached properties. If ``key`` is passed, only clears that key.
        r<   N)hasattrr<   clearpop)r?   rJ   r@   r@   rA   _reset_cache|   s
    
zPandasObject._reset_cacheintc                   s<   t | dd}|r2|dd}tt|r(|n| S t  S )zx
        Generates the total memory usage for an object that returns
        either a value or Series of values
        memory_usageNTdeep)getattrrO   r   sumsuper
__sizeof__)r?   rP   Zmem	__class__r@   rA   rV      s
    
zPandasObject.__sizeof__)N)__name__
__module____qualname____doc____annotations__propertyrB   rG   rN   rV   __classcell__r@   r@   rW   rA   r;   f   s   

r;   c                   @  s(   e Zd ZdZdd ZdddddZd	S )
NoNewAttributesMixina  
    Mixin which prevents adding new attributes.

    Prevents additional attributes via xxx.attribute = "something" after a
    call to `self.__freeze()`. Mainly used to prevent the user from using
    wrong attributes on an accessor (`Series.cat/.str/.dt`).

    If you really want to add a new attribute at a later time, you need to use
    `object.__setattr__(self, key, value)`.
    c                 C  s   t | dd dS )z9
        Prevents setting additional attributes.
        __frozenTN)rF   __setattr__r>   r@   r@   rA   _freeze   s    zNoNewAttributesMixin._freezerC   rH   rI   c                 C  sT   t | ddrB|dksB|t| jksBt | |d d k	sBtd| dt| || d S )Nra   Fr<   z"You cannot add any new attribute '')rS   r=   __dict__AttributeErrorrF   rb   )r?   rJ   valuer@   r@   rA   rb      s    z NoNewAttributesMixin.__setattr__N)rY   rZ   r[   r\   rc   rb   r@   r@   r@   rA   r`      s   r`   c                   @  s   e Zd ZU dZded< dZded< ded< d	d
gZeeZe	e
dd Zedd Ze	eddddZe	edd Zdd ZdddddZdd ZeZdS )SelectionMixinz
    mixin implementing the selection & aggregation interface on a group-like
    object sub-classes need to define: obj, exclusions
    r   objNzIndexLabel | None
_selectionzfrozenset[Hashable]
exclusionsr<   __setstate__c                 C  s&   t | jtttttjfs | jgS | jS N)
isinstancerj   listtupler    r   npndarrayr>   r@   r@   rA   _selection_list   s     zSelectionMixin._selection_listc                 C  s,   | j d kst| jtr| jS | j| j  S d S rm   )rj   rn   ri   r    r>   r@   r@   rA   _selected_obj   s    zSelectionMixin._selected_objrO   rD   c                 C  s   | j jS rm   )rt   ndimr>   r@   r@   rA   ru      s    zSelectionMixin.ndimc                 C  sN   | j d k	r"t| jtr"| j| j S t| jdkrD| jj| jdddS | jS d S )Nr      T)axisZ
only_slice)rj   rn   ri   r   rs   lenrk   Z
_drop_axisr>   r@   r@   rA   _obj_with_exclusions   s
    z#SelectionMixin._obj_with_exclusionsc                 C  s  | j d k	rtd| j  dt|tttttjfrt	| j
j|t	t|krtt|| j
j}tdt|dd  | jt|ddS t| dd	s|| j
jkrtd
| | j|ddS || j
krtd
| | j
| }|j}| j|||dS d S )Nz
Column(s) z already selectedzColumns not found: rv      ru   Zas_indexFzColumn not found: )ru   subset)rj   
IndexErrorrn   ro   rp   r    r   rq   rr   rx   ri   columnsintersectionset
differenceKeyErrorrC   _gotitemrS   ru   )r?   rJ   bad_keysr}   ru   r@   r@   rA   __getitem__   s     


zSelectionMixin.__getitem__r|   c                 C  s   t | dS )a  
        sub-classes to define
        return a sliced object

        Parameters
        ----------
        key : str / list of selections
        ndim : {1, 2}
            requested ndim of result
        subset : object, default None
            subset to act on
        Nr   )r?   rJ   ru   r}   r@   r@   rA   r      s    zSelectionMixin._gotitemc                 O  s   t | d S rm   r   )r?   funcargskwargsr@   r@   rA   	aggregate  s    zSelectionMixin.aggregate)N)rY   rZ   r[   r\   r]   rj   Z_internal_namesr   Z_internal_names_setr
   r^   rs   r   rt   ru   ry   r   r   r   Zaggr@   r@   r@   rA   rh      s*   

rh   c                   @  s  e Zd ZU dZdZedgZded< edddd	Z	ed
dddZ
dddddZeeddZeddddZddddZeddddZdd ZeddddZeddd d!Zed"dd#d$Zd%d&ejfd'd(d)d*d+d,d-Zed(dd.d/Zdd(d1d2d3Zed4d5d6d7dd(dd8d9d:Zdd(d1d;d<Zeed5d4d=d7dddd>d?Zd@dA ZeZdBdC Ze d(ddDdEZ!dFddGdHZ"dId0d%d%dJdKdLdMdNZ#e$ddOdPZ%dd(d(d(d(dQdRdSdTZ&dUdV Z'dd(ddWdXdYZ(ed(ddZd[Z)ed(dd\d]Z*ed(dd^d_Z+ed(dd`daZ,dd(ddbdcddZ-ee.j/dededee01dfdgd&ejejfd(dhdidjdkdlZ/dme2dn< e3ddpdqdrdsdtdudvZ4e3ddwdqdrdxdtdydvZ4ee2dn dzd{dd}dqdrd~dtddvZ4dddZ5e$dddFdddZ6dd Z7dd Z8d%S )r5   zS
    Common ops mixin to support a unified interface / docs for Series / Index
    i  tolistzfrozenset[str]_hidden_attrsr   rD   c                 C  s   t | d S rm   r   r>   r@   r@   rA   dtype  s    zIndexOpsMixin.dtypezExtensionArray | np.ndarrayc                 C  s   t | d S rm   r   r>   r@   r@   rA   _values"  s    zIndexOpsMixin._valuesr9   )r?   rE   c                 O  s   t || | S )zw
        Return the transpose, which is by definition self.

        Returns
        -------
        %(klass)s
        )nvZvalidate_transpose)r?   r   r   r@   r@   rA   	transpose'  s    zIndexOpsMixin.transposezD
        Return the transpose, which is by definition self.
        )r   r   c                 C  s   | j jS )zE
        Return a tuple of the shape of the underlying data.
        )r   shaper>   r@   r@   rA   r   9  s    zIndexOpsMixin.shaperO   c                 C  s   t | d S rm   r   r>   r@   r@   rA   __len__@  s    zIndexOpsMixin.__len__z
Literal[1]c                 C  s   dS )zO
        Number of dimensions of the underlying data, by definition 1.
        rv   r@   r>   r@   r@   rA   ru   D  s    zIndexOpsMixin.ndimc                 C  s$   t | dkrtt| S tddS )a  
        Return the first element of the underlying data as a Python scalar.

        Returns
        -------
        scalar
            The first element of %(klass)s.

        Raises
        ------
        ValueError
            If the data is not length-1.
        rv   z6can only convert an array of size 1 to a Python scalarN)rx   nextiter
ValueErrorr>   r@   r@   rA   itemK  s    zIndexOpsMixin.itemc                 C  s   | j jS )zD
        Return the number of bytes in the underlying data.
        )r   nbytesr>   r@   r@   rA   r   ]  s    zIndexOpsMixin.nbytesc                 C  s
   t | jS )zG
        Return the number of elements in the underlying data.
        )rx   r   r>   r@   r@   rA   sized  s    zIndexOpsMixin.sizer+   c                 C  s   t | dS )aM  
        The ExtensionArray of the data backing this Series or Index.

        Returns
        -------
        ExtensionArray
            An ExtensionArray of the values stored within. For extension
            types, this is the actual array. For NumPy native types, this
            is a thin (no copy) wrapper around :class:`numpy.ndarray`.

            ``.array`` differs ``.values`` which may require converting the
            data to a different form.

        See Also
        --------
        Index.to_numpy : Similar method that always returns a NumPy array.
        Series.to_numpy : Similar method that always returns a NumPy array.

        Notes
        -----
        This table lays out the different array types for each extension
        dtype within pandas.

        ================== =============================
        dtype              array type
        ================== =============================
        category           Categorical
        period             PeriodArray
        interval           IntervalArray
        IntegerNA          IntegerArray
        string             StringArray
        boolean            BooleanArray
        datetime64[ns, tz] DatetimeArray
        ================== =============================

        For any 3rd-party extension types, the array type will be an
        ExtensionArray.

        For all remaining dtypes ``.array`` will be a
        :class:`arrays.NumpyExtensionArray` wrapping the actual ndarray
        stored within. If you absolutely need a NumPy array (possibly with
        copying / coercing data), then use :meth:`Series.to_numpy` instead.

        Examples
        --------
        For regular NumPy types like int, and float, a PandasArray
        is returned.

        >>> pd.Series([1, 2, 3]).array
        <PandasArray>
        [1, 2, 3]
        Length: 3, dtype: int64

        For extension types, like Categorical, the actual ExtensionArray
        is returned

        >>> ser = pd.Series(pd.Categorical(['a', 'b', 'a']))
        >>> ser.array
        ['a', 'b', 'a']
        Categories (2, object): ['a', 'b']
        Nr   r>   r@   r@   rA   arrayk  s    ?zIndexOpsMixin.arrayNFznpt.DTypeLike | NoneboolrF   z
np.ndarray)r   copyna_valuerE   c                 K  s   t | jr$| jj|f||d|S |rHt| d }td| dtj| j	|d}|sf|t
jk	r| }|t
jk	r||t|  < |S )a  
        A NumPy ndarray representing the values in this Series or Index.

        Parameters
        ----------
        dtype : str or numpy.dtype, optional
            The dtype to pass to :meth:`numpy.asarray`.
        copy : bool, default False
            Whether to ensure that the returned value is not a view on
            another array. Note that ``copy=False`` does not *ensure* that
            ``to_numpy()`` is no-copy. Rather, ``copy=True`` ensure that
            a copy is made, even if not strictly necessary.
        na_value : Any, optional
            The value to use for missing values. The default value depends
            on `dtype` and the type of the array.

            .. versionadded:: 1.0.0

        **kwargs
            Additional keywords passed through to the ``to_numpy`` method
            of the underlying array (for extension arrays).

            .. versionadded:: 1.0.0

        Returns
        -------
        numpy.ndarray

        See Also
        --------
        Series.array : Get the actual data stored within.
        Index.array : Get the actual data stored within.
        DataFrame.to_numpy : Similar method for DataFrame.

        Notes
        -----
        The returned array will be the same up to equality (values equal
        in `self` will be equal in the returned array; likewise for values
        that are not equal). When `self` contains an ExtensionArray, the
        dtype may be different. For example, for a category-dtype Series,
        ``to_numpy()`` will return a NumPy array and the categorical dtype
        will be lost.

        For NumPy dtypes, this will be a reference to the actual data stored
        in this Series or Index (assuming ``copy=False``). Modifying the result
        in place will modify the data stored in the Series or Index (not that
        we recommend doing that).

        For extension types, ``to_numpy()`` *may* require copying data and
        coercing the result to a NumPy type (possibly object), which may be
        expensive. When you need a no-copy reference to the underlying data,
        :attr:`Series.array` should be used instead.

        This table lays out the different dtypes and default return types of
        ``to_numpy()`` for various dtypes within pandas.

        ================== ================================
        dtype              array type
        ================== ================================
        category[T]        ndarray[T] (same dtype as input)
        period             ndarray[object] (Periods)
        interval           ndarray[object] (Intervals)
        IntegerNA          ndarray[object]
        datetime64[ns]     datetime64[ns]
        datetime64[ns, tz] ndarray[object] (Timestamps)
        ================== ================================

        Examples
        --------
        >>> ser = pd.Series(pd.Categorical(['a', 'b', 'a']))
        >>> ser.to_numpy()
        array(['a', 'b', 'a'], dtype=object)

        Specify the `dtype` to control how datetime-aware data is represented.
        Use ``dtype=object`` to return an ndarray of pandas :class:`Timestamp`
        objects, each with the correct ``tz``.

        >>> ser = pd.Series(pd.date_range('2000', periods=2, tz="CET"))
        >>> ser.to_numpy(dtype=object)
        array([Timestamp('2000-01-01 00:00:00+0100', tz='CET'),
               Timestamp('2000-01-02 00:00:00+0100', tz='CET')],
              dtype=object)

        Or ``dtype='datetime64[ns]'`` to return an ndarray of native
        datetime64 values. The values are converted to UTC and the timezone
        info is dropped.

        >>> ser.to_numpy(dtype="datetime64[ns]")
        ... # doctest: +ELLIPSIS
        array(['1999-12-31T23:00:00.000000000', '2000-01-01T23:00:00...'],
              dtype='datetime64[ns]')
        )r   r   r   z/to_numpy() got an unexpected keyword argument 'rd   )r   )r   r   r   to_numpyro   keys	TypeErrorrq   asarrayr   lib
no_defaultr   Z
asanyarrayr!   )r?   r   r   r   r   r   resultr@   r@   rA   r     s    c


zIndexOpsMixin.to_numpyc                 C  s   | j  S rm   )r   r>   r@   r@   rA   empty  s    zIndexOpsMixin.emptyTskipnac                 O  s&   t | t || tj| j|dS )a  
        Return the maximum value of the Index.

        Parameters
        ----------
        axis : int, optional
            For compatibility with NumPy. Only 0 or None are allowed.
        skipna : bool, default True
            Exclude NA/null values when showing the result.
        *args, **kwargs
            Additional arguments and keywords for compatibility with NumPy.

        Returns
        -------
        scalar
            Maximum value.

        See Also
        --------
        Index.min : Return the minimum value in an Index.
        Series.max : Return the maximum value in a Series.
        DataFrame.max : Return the maximum values in a DataFrame.

        Examples
        --------
        >>> idx = pd.Index([3, 2, 1])
        >>> idx.max()
        3

        >>> idx = pd.Index(['c', 'b', 'a'])
        >>> idx.max()
        'c'

        For a MultiIndex, the maximum is determined lexicographically.

        >>> idx = pd.MultiIndex.from_product([('a', 'b'), (2, 1)])
        >>> idx.max()
        ('b', 2)
        r   )r   validate_minmax_axisZvalidate_maxr$   Znanmaxr   r?   rw   r   r   r   r@   r@   rA   max#  s    (
zIndexOpsMixin.maxr   minlargest)opZopposerg   )r   rE   c                 O  sX   | j }t| t|||}t|trF|s<|  r<dS | S nt	j
||dS dS )ab  
        Return int position of the {value} value in the Series.

        If the {op}imum is achieved in multiple locations,
        the first row position is returned.

        Parameters
        ----------
        axis : {{None}}
            Unused. Parameter needed for compatibility with DataFrame.
        skipna : bool, default True
            Exclude NA/null values when showing the result.
        *args, **kwargs
            Additional arguments and keywords for compatibility with NumPy.

        Returns
        -------
        int
            Row position of the {op}imum value.

        See Also
        --------
        Series.arg{op} : Return position of the {op}imum value.
        Series.arg{oppose} : Return position of the {oppose}imum value.
        numpy.ndarray.arg{op} : Equivalent method for numpy arrays.
        Series.idxmax : Return index label of the maximum values.
        Series.idxmin : Return index label of the minimum values.

        Examples
        --------
        Consider dataset containing cereal calories

        >>> s = pd.Series({{'Corn Flakes': 100.0, 'Almond Delight': 110.0,
        ...                'Cinnamon Toast Crunch': 120.0, 'Cocoa Puff': 110.0}})
        >>> s
        Corn Flakes              100.0
        Almond Delight           110.0
        Cinnamon Toast Crunch    120.0
        Cocoa Puff               110.0
        dtype: float64

        >>> s.argmax()
        2
        >>> s.argmin()
        0

        The maximum cereal calories is the third element and
        the minimum cereal calories is the first element,
        since series is zero-indexed.
        rz   r   N)r   r   r   Zvalidate_argmax_with_skipnarn   r+   r!   anyargmaxr$   Z	nanargmaxr?   rw   r   r   r   Zdelegater@   r@   rA   r   O  s    4


 zIndexOpsMixin.argmaxc                 O  s&   t | t || tj| j|dS )a  
        Return the minimum value of the Index.

        Parameters
        ----------
        axis : {None}
            Dummy argument for consistency with Series.
        skipna : bool, default True
            Exclude NA/null values when showing the result.
        *args, **kwargs
            Additional arguments and keywords for compatibility with NumPy.

        Returns
        -------
        scalar
            Minimum value.

        See Also
        --------
        Index.max : Return the maximum value of the object.
        Series.min : Return the minimum value in a Series.
        DataFrame.min : Return the minimum values in a DataFrame.

        Examples
        --------
        >>> idx = pd.Index([3, 2, 1])
        >>> idx.min()
        1

        >>> idx = pd.Index(['c', 'b', 'a'])
        >>> idx.min()
        'a'

        For a MultiIndex, the minimum is determined lexicographically.

        >>> idx = pd.MultiIndex.from_product([('a', 'b'), (2, 1)])
        >>> idx.min()
        ('a', 1)
        r   )r   r   Zvalidate_minr$   Znanminr   r   r@   r@   rA   r     s    (
zIndexOpsMixin.minsmallestc                 O  sX   | j }t| t|||}t|trF|s<|  r<dS | S nt	j
||dS d S )Nrz   r   )r   r   r   Zvalidate_argmin_with_skipnarn   r+   r!   r   argminr$   Z	nanargminr   r@   r@   rA   r     s    


 zIndexOpsMixin.argminc                 C  s
   | j  S )a  
        Return a list of the values.

        These are each a scalar type, which is a Python scalar
        (for str, int, float) or a pandas scalar
        (for Timestamp/Timedelta/Interval/Period)

        Returns
        -------
        list

        See Also
        --------
        numpy.ndarray.tolist : Return the array as an a.ndim-levels deep
            nested list of Python scalars.
        )r   r   r>   r@   r@   rA   r     s    zIndexOpsMixin.tolistc                 C  s2   t | jtjst| jS t| jjt| jjS dS )a  
        Return an iterator of the values.

        These are each a scalar type, which is a Python scalar
        (for str, int, float) or a pandas scalar
        (for Timestamp/Timedelta/Interval/Period)

        Returns
        -------
        iterator
        N)	rn   r   rq   rr   r   mapr   ranger   r>   r@   r@   rA   __iter__  s    
zIndexOpsMixin.__iter__c                 C  s   t t|  S )zc
        Return True if there are any NaNs.

        Enables various performance speedups.
        )r   r!   r   r>   r@   r@   rA   hasnans  s    	zIndexOpsMixin.hasnansznpt.NDArray[np.bool_]c                 C  s
   t | jS rm   )r!   r   r>   r@   r@   rA   r!     s    zIndexOpsMixin.isnar   )rw   r   numeric_onlyfilter_typerC   namec          	      K  s>   t | |d}|dkr,tt| j d| |f d|i|S )zA
        Perform the reduction type operation if we can.
        Nz cannot perform the operation r   )rS   r   r=   rY   )	r?   r   r   rw   r   r   r   kwdsr   r@   r@   rA   _reduce  s    zIndexOpsMixin._reducec           	        sB  t |r<t|tr.t|dr.|  fdd}nt|tjd}t|tr|dkrbd| d}t||dkrx||j	
  }t| jrtd	| j}||S | j}|j	|}t|j|}|S t| jrt| jd
r| j}|dk	rtdd }nF| jt}|dkrdd }n&|dkr tj}nd| d}t||||}|S )a  
        An internal function that maps values using the input
        correspondence (which can be a dict, Series, or function).

        Parameters
        ----------
        mapper : function, dict, or Series
            The input correspondence object
        na_action : {None, 'ignore'}
            If 'ignore', propagate NA values, without passing them to the
            mapping function

        Returns
        -------
        Union[Index, MultiIndex], inferred
            The output of the mapping function applied to the index.
            If the function returns a tuple with more than one element
            a MultiIndex will be returned.
        __missing__c                   s    |  S rm   r@   )xZdict_with_defaultr@   rA   <lambda>9      z+IndexOpsMixin._map_values.<locals>.<lambda>)Zdtype_if_empty)Nignorez+na_action must either be 'ignore' or None, z was passedr   r2   r   Nc                 S  s
   |  |S rm   )r   valuesfr@   r@   rA   r   i  r   c                 S  s   t | |t| tjS rm   )r   Zmap_infer_maskr!   viewrq   Zuint8r   r@   r@   rA   r   m  s     )r   rn   dictrK   r,   rq   Zfloat64r    r   indexZnotnar   r   r	   r   r   Zget_indexerr#   Ztake_ndr   NotImplementedErrorZastyperF   r   Z	map_infer)	r?   ZmapperZ	na_actionmsgcatr   ZindexerZ
new_valuesZmap_fr@   r   rA   _map_values  sJ     









zIndexOpsMixin._map_valuesr3   )	normalizesort	ascendingdropnarE   c                 C  s   t | |||||dS )a  
        Return a Series containing counts of unique values.

        The resulting object will be in descending order so that the
        first element is the most frequently-occurring element.
        Excludes NA values by default.

        Parameters
        ----------
        normalize : bool, default False
            If True then the object returned will contain the relative
            frequencies of the unique values.
        sort : bool, default True
            Sort by frequencies.
        ascending : bool, default False
            Sort in ascending order.
        bins : int, optional
            Rather than count values, group them into half-open bins,
            a convenience for ``pd.cut``, only works with numeric data.
        dropna : bool, default True
            Don't include counts of NaN.

        Returns
        -------
        Series

        See Also
        --------
        Series.count: Number of non-NA elements in a Series.
        DataFrame.count: Number of non-NA elements in a DataFrame.
        DataFrame.value_counts: Equivalent method on DataFrames.

        Examples
        --------
        >>> index = pd.Index([3, 1, 2, 3, 4, np.nan])
        >>> index.value_counts()
        3.0    2
        1.0    1
        2.0    1
        4.0    1
        dtype: int64

        With `normalize` set to `True`, returns the relative frequency by
        dividing all values by the sum of values.

        >>> s = pd.Series([3, 1, 2, 3, 4, np.nan])
        >>> s.value_counts(normalize=True)
        3.0    0.4
        1.0    0.2
        2.0    0.2
        4.0    0.2
        dtype: float64

        **bins**

        Bins can be useful for going from a continuous variable to a
        categorical variable; instead of counting unique
        apparitions of values, divide the index in the specified
        number of half-open bins.

        >>> s.value_counts(bins=3)
        (0.996, 2.0]    2
        (2.0, 3.0]      2
        (3.0, 4.0]      1
        dtype: int64

        **dropna**

        With `dropna` set to `False` we can also see NaN index values.

        >>> s.value_counts(dropna=False)
        3.0    2
        1.0    1
        2.0    1
        4.0    1
        NaN    1
        dtype: int64
        )r   r   r   binsr   )r)   )r?   r   r   r   r   r   r@   r@   rA   r)   ~  s    VzIndexOpsMixin.value_countsc                 C  sV   | j }t|tjsJ| }t| jtjrR| jjdkrRt| trRt|}nt	|}|S )N)mM)
r   rn   rq   rr   r8   r   kindr    r   r(   )r?   r   r   r@   r@   rA   r8     s    
zIndexOpsMixin.unique)r   rE   c                 C  s   |   }|rt|}t|S )a  
        Return number of unique elements in the object.

        Excludes NA values by default.

        Parameters
        ----------
        dropna : bool, default True
            Don't include NaN in the count.

        Returns
        -------
        int

        See Also
        --------
        DataFrame.nunique: Method nunique for DataFrame.
        Series.count: Count non-NA/null observations in the Series.

        Examples
        --------
        >>> s = pd.Series([1, 3, 5, 7, 7])
        >>> s
        0    1
        1    3
        2    5
        3    7
        4    7
        dtype: int64

        >>> s.nunique()
        4
        )r8   r"   rx   )r?   r   Zuniqsr@   r@   rA   nunique  s    "zIndexOpsMixin.nuniquec                 C  s   | j ddt| kS )zr
        Return boolean if values in the object are unique.

        Returns
        -------
        bool
        F)r   )r   rx   r>   r@   r@   rA   	is_unique  s    	zIndexOpsMixin.is_uniquec                 C  s   t jdtt d | jS )a$  
        Return boolean if values in the object are monotonically increasing.

        .. deprecated:: 1.5.0
            is_monotonic is deprecated and will be removed in a future version.
            Use is_monotonic_increasing instead.

        Returns
        -------
        bool
        zhis_monotonic is deprecated and will be removed in a future version. Use is_monotonic_increasing instead.)
stacklevel)warningswarnFutureWarningr   is_monotonic_increasingr>   r@   r@   rA   is_monotonic  s    zIndexOpsMixin.is_monotonicc                 C  s   ddl m} || jS )z
        Return boolean if values in the object are monotonically increasing.

        Returns
        -------
        bool
        r   Index)pandasr   r   r?   r   r@   r@   rA   r   4  s    	z%IndexOpsMixin.is_monotonic_increasingc                 C  s   ddl m} || jS )z
        Return boolean if values in the object are monotonically decreasing.

        Returns
        -------
        bool
        r   r   )r   r   is_monotonic_decreasingr   r@   r@   rA   r   A  s    	z%IndexOpsMixin.is_monotonic_decreasing)rR   rE   c                 C  sR   t | jdr| jj|dS | jj}|rNt| rNtsNttj| j	}|t
|7 }|S )aN  
        Memory usage of the values.

        Parameters
        ----------
        deep : bool, default False
            Introspect the data deeply, interrogate
            `object` dtypes for system-level memory consumption.

        Returns
        -------
        bytes used

        See Also
        --------
        numpy.ndarray.nbytes : Total bytes consumed by the elements of the
            array.

        Notes
        -----
        Memory usage does not include memory consumed by elements that
        are not components of the array if deep=False or if used on PyPy
        rP   rQ   )rK   r   rP   r   r   r   r	   rq   rr   r   r   Zmemory_usage_of_objects)r?   rR   vr   r@   r@   rA   _memory_usageN  s    zIndexOpsMixin._memory_usager6   z            sort : bool, default False
                Sort `uniques` and shuffle `codes` to maintain the
                relationship.
            )r   orderZ	size_hintr   zint | lib.NoDefaultzbool | lib.NoDefaultr   na_sentineluse_na_sentinelc                 C  s   t j| |||dS )Nr   )r#   	factorize)r?   r   r   r   r@   r@   rA   r   q  s       zIndexOpsMixin.factorizea  
        Find indices where elements should be inserted to maintain order.

        Find the indices into a sorted {klass} `self` such that, if the
        corresponding elements in `value` were inserted before the indices,
        the order of `self` would be preserved.

        .. note::

            The {klass} *must* be monotonically sorted, otherwise
            wrong locations will likely be returned. Pandas does *not*
            check this for you.

        Parameters
        ----------
        value : array-like or scalar
            Values to insert into `self`.
        side : {{'left', 'right'}}, optional
            If 'left', the index of the first suitable location found is given.
            If 'right', return the last such index.  If there is no suitable
            index, return either 0 or N (where N is the length of `self`).
        sorter : 1-D array-like, optional
            Optional array of integer indices that sort `self` into ascending
            order. They are typically the result of ``np.argsort``.

        Returns
        -------
        int or array of int
            A scalar or array of insertion points with the
            same shape as `value`.

        See Also
        --------
        sort_values : Sort by the values along either axis.
        numpy.searchsorted : Similar method from NumPy.

        Notes
        -----
        Binary search is used to find the required insertion points.

        Examples
        --------
        >>> ser = pd.Series([1, 2, 3])
        >>> ser
        0    1
        1    2
        2    3
        dtype: int64

        >>> ser.searchsorted(4)
        3

        >>> ser.searchsorted([0, 4])
        array([0, 3])

        >>> ser.searchsorted([1, 3], side='left')
        array([0, 2])

        >>> ser.searchsorted([1, 3], side='right')
        array([1, 3])

        >>> ser = pd.Series(pd.to_datetime(['3/11/2000', '3/12/2000', '3/13/2000']))
        >>> ser
        0   2000-03-11
        1   2000-03-12
        2   2000-03-13
        dtype: datetime64[ns]

        >>> ser.searchsorted('3/14/2000')
        3

        >>> ser = pd.Categorical(
        ...     ['apple', 'bread', 'bread', 'cheese', 'milk'], ordered=True
        ... )
        >>> ser
        ['apple', 'bread', 'bread', 'cheese', 'milk']
        Categories (4, object): ['apple' < 'bread' < 'cheese' < 'milk']

        >>> ser.searchsorted('bread')
        1

        >>> ser.searchsorted(['bread'], side='right')
        array([3])

        If the values are not monotonically sorted, wrong locations
        may be returned:

        >>> ser = pd.Series([2, 1, 3])
        >>> ser
        0    2
        1    1
        2    3
        dtype: int64

        >>> ser.searchsorted(1)  # doctest: +SKIP
        0  # wrong result, correct would be 1
        searchsorted.r1   zLiteral[('left', 'right')]r/   znp.intp)rg   sidesorterrE   c                 C  s   d S rm   r@   r?   rg   r   r   r@   r@   rA   r     s    zIndexOpsMixin.searchsortedznpt.ArrayLike | ExtensionArrayznpt.NDArray[np.intp]c                 C  s   d S rm   r@   r   r@   r@   rA   r     s    r   )r7   leftz$NumpyValueArrayLike | ExtensionArrayznpt.NDArray[np.intp] | np.intpc                 C  s4   | j }t|tjs"|j|||dS tj||||dS )N)r   r   )r   rn   rq   rr   r   r#   )r?   rg   r   r   r   r@   r@   rA   r     s    firstc                 C  s   | j |d}| |  S N)keep)_duplicated)r?   r   r'   r@   r@   rA   drop_duplicates  s    zIndexOpsMixin.drop_duplicatesz!Literal[('first', 'last', False)])r   rE   c                 C  s   t | j|dS r   )r'   r   )r?   r   r@   r@   rA   r     s    zIndexOpsMixin._duplicatedc              	   C  sj   t | |}| j}t|ddd}t ||j}t|}tjdd t 	|||}W 5 Q R X | j
||dS )NT)Zextract_numpyZextract_ranger   )allr   )r%   Zget_op_result_namer   r.   Zmaybe_prepare_scalar_for_opr   r-   rq   ZerrstateZarithmetic_op_construct_result)r?   otherr   Zres_nameZlvaluesZrvaluesr   r@   r@   rA   _arith_method$  s    zIndexOpsMixin._arith_methodc                 C  s   t | dS )z~
        Construct an appropriately-wrapped result from the ArrayLike result
        of an arithmetic-like operation.
        Nr   )r?   r   r   r@   r@   rA   r   1  s    zIndexOpsMixin._construct_result)NT)NT)NT)NT)N)FTFNT)T)F)..)..)r   N)r   )r   )9rY   rZ   r[   r\   Z__array_priority__	frozensetr   r]   r^   r   r   r   Tr   r   ru   r   r   r   r   r   r   r   r   r   r   r   r   r   r   Zto_listr   r   r   r!   r   r
   r   r)   r8   r   r   r   r   r   r   r#   r   textwrapdedentr4   r   r   r   r   r   r   r@   r@   r@   rA   r5     s   
Bs,C,
c     _'
#g      
 )Tr\   
__future__r   r   typingr   r   r   r   r   r   r	   r
   r   r   Znumpyrq   Zpandas._libs.libZ_libsr   Zpandas._typingr   r   r   r   r   r   Zpandas.compatr   Zpandas.compat.numpyr   r   Zpandas.errorsr   Zpandas.util._decoratorsr   r   Zpandas.util._exceptionsr   Zpandas.core.dtypes.commonr   r   r   r   r   Zpandas.core.dtypes.genericr   r   r    Zpandas.core.dtypes.missingr!   r"   Zpandas.corer#   r$   r%   Zpandas.core.accessorr&   Zpandas.core.algorithmsr'   r(   r)   Zpandas.core.arrayliker*   Zpandas.core.arraysr+   Zpandas.core.constructionr,   r-   r.   r/   r0   r1   r   r2   r3   r4   r]   Z_indexops_doc_kwargsr9   r;   r`   rh   r5   r@   r@   r@   rA   <module>   sF   , /"[