docstring to _ncut_cy.pys

2026-07-08 12:31:49 +08:00 · 2014-07-23 04:12:23 +05:30
parent 273b9d081e
commit 9c8b1efd26
1 changed files with 12 additions and 0 deletions
@@ -7,6 +7,18 @@ import numpy as np


 def argmin2(cnp.float64_t[:] array):
+    """Return the index of the 2nd smallest value in an array.
+
+    Parameters
+    ----------
+    a : array
+        The array to process.
+
+    Returns
+    -------
+    i : int
+        The index of the second smallest value.
+    """
    cdef cnp.float64_t min1 = np.inf
    cdef cnp.float64_t min2 = np.inf
    cdef Py_ssize_t i1 = 0