adjusts the documentation for ucx_array_sort() to the current plans feature/array

Wed, 07 Aug 2019 19:43:50 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 07 Aug 2019 19:43:50 +0200
branch
feature/array
changeset 343
c09da4ee177f
parent 342
8f0a3c00d1d2
child 344
320b962afaf9

adjusts the documentation for ucx_array_sort() to the current plans

src/ucx/array.h file | annotate | diff | comparison | revisions
     1.1 --- a/src/ucx/array.h	Tue Aug 06 16:26:46 2019 +0200
     1.2 +++ b/src/ucx/array.h	Wed Aug 07 19:43:50 2019 +0200
     1.3 @@ -234,16 +234,12 @@
     1.4  /**
     1.5   * Sorts a UcxArray with the best available sort algorithm.
     1.6   * 
     1.7 - * If present, qsort_s() will be used. Otherwise, if no additional data is
     1.8 - * specified, qsort() is used as a fall back.
     1.9 - * 
    1.10 - * If qsort_s() is not available and <code>data</code> is not <code>NULL</code>,
    1.11 - * a custom almost in-place merge sort algorithm is used, which uses additional
    1.12 - * memory for exactly one element.
    1.13 + * A merge sort algorithm is used, which is guaranteed to use no more additional
    1.14 + * memory than for exactly one element.
    1.15   * 
    1.16   * @param array the array to sort
    1.17   * @param cmpfnc the function that shall be used to compare the element data
    1.18 - * @param data additional data for the cmp_func()
    1.19 + * @param data additional data for the cmp_func() or <code>NULL</code>
    1.20   */
    1.21  void ucx_array_sort(UcxArray array, cmp_func cmpfnc, void *data);
    1.22  

mercurial