add doc to xicor

janoPig · Aug 31, 2024 · af261cd · af261cd
1 parent 741eaff
commit af261cd
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/HROCH/hroch.py b/HROCH/hroch.py
@@ -442,6 +442,21 @@ def __repr__(self):
 Xicor64.restype = ctypes.c_double
 
 def Xicor(X : numpy.ndarray, Y:numpy.ndarray):
+    """
+    Xicor corelation coefficient.
+
+    This function computes the xi coefficient between two vectors x and y.
+
+    Parameters
+    ----------
+    X : array-like input vector x
+
+    Y : array-like input vector y
+
+    Returns
+    -------
+    xi : float
+    """
     if X.ndim != 1:
         X = numpy.ravel(X)
     if Y.ndim != 1: