view docs/ccguide/qsort.refentry @ 532:72f3c79b0674

Mainly section structures added.
author roug
date Sat, 12 Oct 2002 12:03:22 +0000
parents f0c8d53e5a50
children d9ab3688bb71
line wrap: on
line source

<refentry id="qsort">
<refnamediv>
<refname>qsort</refname>
<refpurpose>Placeholder</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>