Ë
    þÍ:jÛ  ã                   óö   — d dl Z d dlmZ d dlZd dlmZ d dlmZ d dlmZ d dl	m
Z
mZmZmZ 	 	 ddeded	ed
ed   dee   defd„Zdedefd„Z	 	 ddeded
ed   dee   def
d„Z	 	 dded
ed   dee   defd„Zy)é    N)ÚOptional)ÚTensor)ÚLiteral)Ú#_multiclass_confusion_matrix_update)Ú_compute_chi_squaredÚ_drop_empty_rows_and_colsÚ_handle_nan_in_dataÚ_nominal_input_validationÚpredsÚtargetÚnum_classesÚnan_strategy)ÚreplaceÚdropÚnan_replace_valueÚreturnc                 óÆ   — | j                   dk(  r| j                  d«      n| } |j                   dk(  r|j                  d«      n|}t        | |||«      \  } }t        | ||«      S )a  Compute the bins to update the confusion matrix with for Pearson's Contingency Coefficient calculation.

    Args:
        preds: 1D or 2D tensor of categorical (nominal) data
        target: 1D or 2D tensor of categorical (nominal) data
        num_classes: Integer specifying the number of classes
        nan_strategy: Indication of whether to replace or drop ``NaN`` values
        nan_replace_value: Value to replace ``NaN`s when ``nan_strategy = 'replace```

    Returns:
        Non-reduced confusion matrix

    é   é   )ÚndimÚargmaxr	   r   )r   r   r   r   r   s        ú|/home/mcse/projects/srt_converter/srt-converter-venv/lib/python3.12/site-packages/torchmetrics/functional/nominal/pearson.pyÚ(_pearsons_contingency_coefficient_updater      s\   € ð(  %Ÿz™z¨QšˆE�L‰L˜ŒO°E€EØ!'§¡°Ò!1ˆV�]‰]˜1Ô°v€FÜ'¨¨v°|ÐEVÓW�M€Eˆ6Ü.¨u°f¸kÓJÐJó    Úconfmatc                 ó¶   — t        | «      } | j                  «       }t        | d¬«      }||z  }t        j                  |d|z   z  «      }|j                  dd«      S )zÐCompute Pearson's Contingency Coefficient based on a pre-computed confusion matrix.

    Args:
        confmat: Confusion matrix for observed data

    Returns:
        Pearson's Contingency Coefficient

    F)Úbias_correctionr   ç        g      ð?)r   Úsumr   ÚtorchÚsqrtÚclamp)r   Úcm_sumÚchi_squaredÚphi_squaredÚtschuprows_t_values        r   Ú)_pearsons_contingency_coefficient_computer'   8   sZ   € ô (¨Ó0€GØ�[‰[‹]€FÜ& wÀÔF€KØ Ñ&€KäŸ™ K°1°{±?Ñ$CÓDÐØ×#Ñ# C¨Ó-Ð-r   c                 óª   — t        ||«       t        t        j                  | |g«      j	                  «       «      }t        | ||||«      }t        |«      S )aJ  Compute `Pearson's Contingency Coefficient`_ for measuring the association between two categorical data series.

    .. math::
        Pearson = \sqrt{\frac{\chi^2 / n}{1 + \chi^2 / n}}

    where

    .. math::
        \chi^2 = \sum_{i,j} \ frac{\left(n_{ij} - \frac{n_{i.} n_{.j}}{n}\right)^2}{\frac{n_{i.} n_{.j}}{n}}

    where :math:`n_{ij}` denotes the number of times the values :math:`(A_i, B_j)` are observed with :math:`A_i, B_j`
    represent frequencies of values in ``preds`` and ``target``, respectively.

    Pearson's Contingency Coefficient is a symmetric coefficient, i.e.
    :math:`Pearson(preds, target) = Pearson(target, preds)`.

    The output values lies in [0, 1] with 1 meaning the perfect association.

    Args:
        preds: 1D or 2D tensor of categorical (nominal) data:

            - 1D shape: (batch_size,)
            - 2D shape: (batch_size, num_classes)

        target: 1D or 2D tensor of categorical (nominal) data:

            - 1D shape: (batch_size,)
            - 2D shape: (batch_size, num_classes)

        nan_strategy: Indication of whether to replace or drop ``NaN`` values
        nan_replace_value: Value to replace ``NaN``s when ``nan_strategy = 'replace'``

    Returns:
        Pearson's Contingency Coefficient

    Example:
        >>> from torch import randint, round
        >>> from torchmetrics.functional.nominal import pearsons_contingency_coefficient
        >>> preds = randint(0, 4, (100,))
        >>> target = round(preds + torch.randn(100)).clamp(0, 4)
        >>> pearsons_contingency_coefficient(preds, target)
        tensor(0.6948)

    )r
   Úlenr    ÚcatÚuniquer   r'   )r   r   r   r   r   r   s         r   Ú pearsons_contingency_coefficientr,   K   sO   € ôd ˜lÐ,=Ô>Ü”e—i‘i ¨ Ó0×7Ñ7Ó9Ó:€KÜ6°u¸fÀkÐS_ÐarÓs€GÜ4°WÓ=Ð=r   Úmatrixc                 óž  — t        ||«       | j                  d   }t        j                  ||| j                  ¬«      }t        j                  t        |«      d«      D ]m  \  }}| dd…|f   | dd…|f   }}t        t        j                  ||g«      j                  «       «      }	t        |||	||«      }
t        |
«      }|x|||f<   |||f<   Œo |S )a   Compute `Pearson's Contingency Coefficient`_ statistic between a set of multiple variables.

    This can serve as a convenient tool to compute Pearson's Contingency Coefficient for analyses
    of correlation between categorical variables in your dataset.

    Args:
        matrix: A tensor of categorical (nominal) data, where:

            - rows represent a number of data points
            - columns represent a number of categorical (nominal) features

        nan_strategy: Indication of whether to replace or drop ``NaN`` values
        nan_replace_value: Value to replace ``NaN``s when ``nan_strategy = 'replace'``

    Returns:
        Pearson's Contingency Coefficient statistic for a dataset of categorical variables

    Example:
        >>> from torch import randint
        >>> from torchmetrics.functional.nominal import pearsons_contingency_coefficient_matrix
        >>> matrix = randint(0, 4, (200, 5))
        >>> pearsons_contingency_coefficient_matrix(matrix)
        tensor([[1.0000, 0.2326, 0.1959, 0.2262, 0.2989],
                [0.2326, 1.0000, 0.1386, 0.1895, 0.1329],
                [0.1959, 0.1386, 1.0000, 0.1840, 0.2335],
                [0.2262, 0.1895, 0.1840, 1.0000, 0.2737],
                [0.2989, 0.1329, 0.2335, 0.2737, 1.0000]])

    r   )Údevicer   N)r
   Úshaper    Úonesr/   Ú	itertoolsÚcombinationsÚranger)   r*   r+   r   r'   )r-   r   r   Únum_variablesÚpearsons_cont_coef_matrix_valueÚiÚjÚxÚyr   r   Úvals               r   Ú'pearsons_contingency_coefficient_matrixr<   ƒ   sÝ   € ôD ˜lÐ,=Ô>Ø—L‘L ‘O€MÜ&+§j¡j°ÀÐV\×VcÑVcÔ&dÐ#Ü×&Ñ&¤u¨]Ó';¸QÓ?ò \‰ˆˆ1Ø’a˜�d‰|˜V¢A q D™\ˆ1ˆÜœ%Ÿ)™) Q¨ FÓ+×2Ñ2Ó4Ó5ˆÜ:¸1¸aÀÈlÐ\mÓnˆÜ7¸Ó@ˆØX[Ð[Ð'¨¨1¨Ñ-Ð0OÐPQÐSTÐPTÒ0Uð\ð +Ð*r   )r   r   )r2   Útypingr   r    r   Útyping_extensionsr   Ú7torchmetrics.functional.classification.confusion_matrixr   Ú%torchmetrics.functional.nominal.utilsr   r   r	   r
   ÚintÚfloatr   r'   r,   r<   © r   r   ú<module>rD      s  ðó Ý ã Ý Ý %å g÷ó ð 09Ø),ñKØðKàðKð ðKð Ð+Ñ,ð	Kð
   ‘ðKð óKð4.°vð .À&ó .ð, 09Ø),ñ	5>Øð5>àð5>ð Ð+Ñ,ð5>ð   ‘ð	5>ð
 ó5>ðt 09Ø),ñ++Øð++àÐ+Ñ,ð++ð   ‘ð++ð ô	++r   