view docs/ccguide/qsort.refentry @ 3115:460fdd304adf

term_mc6850: Include the matching IT.xxx symbols in the comments
author Neal Crook <foofoobedoo@gmail.com>
date Sat, 17 Oct 2015 21:21:11 +0100
parents d9ab3688bb71
children
line wrap: on
line source

<refentry id="qsort">
<refnamediv>
<refname>Qsort</refname>
<refpurpose>quick sort</refpurpose>
</refnamediv>

<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
  <funcdef><function>qsort</function></funcdef>
  <paramdef>char *<parameter>base</parameter></paramdef>
  <paramdef>int <parameter>n</parameter></paramdef>
  <paramdef>int <parameter>size</parameter></paramdef>
  <paramdef>int <parameter>(* compfunc)</parameter>
      <funcparams>void *, void *</funcparams></paramdef>
</funcprototype>
</funcsynopsis>

</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
Qsort implements the quick-sort algoritm for sortig an
arbitrary array of items.
</para>
<para>
"Base" is the address of the array of "n" items of size "size".
"Compfunc" is a pointer to a comparison routine supplied by
the user. It will be called by qsort with two pointers to
items in the array for comparison and should return an integer
which is less than, equal to, or greater than 0 where,
respectively, the first item is less than, equal to, or greater
than the second.
</para>
</refsect1>
</refentry>