/src/gnutls/lib/unistring/array-mergesort.h

Source
/* Stable-sorting of an array using mergesort.
   Copyright (C) 2009-2026 Free Software Foundation, Inc.
   Written by Bruno Haible <bruno@clisp.org>, 2009.

   This file is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   License, or (at your option) any later version.

   This file is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.  */

/* This file implements stable sorting of an array, using the mergesort
   algorithm.
   Worst-case running time for an array of length N is O(N log N).
   Unlike the mpsort module, the algorithm here attempts to minimize not
   only the number of comparisons, but also the number of copying operations.

   Before including this file, you need to define
     ELEMENT      The type of every array element.
     COMPARE      A two-argument macro that takes two 'const ELEMENT *'
                  pointers and returns a negative, zero, or positive 'int'
                  value if the element pointed to by the first argument is,
                  respectively, less, equal, or greater than the element
                  pointed to by the second argument.
     STATIC       The storage class of the functions being defined.
     STATIC_FROMTO  (Optional.) Overrides STATIC for the 'merge_sort_fromto'
                    function.
   Before including this file, you also need to include:
     #include <stddef.h>
 */

/* Merge the sorted arrays src1[0..n1-1] and src2[0..n2-1] into
   dst[0..n1+n2-1].  In case of ambiguity, put the elements of src1
   before the elements of src2.
   n1 and n2 must be > 0.
   The arrays src1 and src2 must not overlap the dst array, except that
   src1 may be dst[n2..n1+n2-1], or src2 may be dst[n1..n1+n2-1].  */
static void
merge (const ELEMENT *src1, size_t n1,
       const ELEMENT *src2, size_t n2,
       ELEMENT *dst)
{
  for (;;) /* while (n1 > 0 && n2 > 0) */
    {
      if (COMPARE (src1, src2) <= 0)
        {
          *dst++ = *src1++;
          n1--;
          if (n1 == 0)
            break;
        }
      else
        {
          *dst++ = *src2++;
          n2--;
          if (n2 == 0)
            break;
        }
    }
  /* Here n1 == 0 || n2 == 0 but also n1 > 0 || n2 > 0.  */
  if (n1 > 0)
    {
      if (dst != src1)
        do
          {
            *dst++ = *src1++;
            n1--;
          }
        while (n1 > 0);
    }
  else /* n2 > 0 */
    {
      if (dst != src2)
        do
          {
            *dst++ = *src2++;
            n2--;
          }
        while (n2 > 0);
    }
}

/* Sort src[0..n-1] into dst[0..n-1], using tmp[0..n/2-1] as temporary
   (scratch) storage.
   The arrays src, dst, tmp must not overlap.  */
#ifdef STATIC_FROMTO
STATIC_FROMTO
#else
STATIC
#endif
void
merge_sort_fromto (const ELEMENT *src, ELEMENT *dst, size_t n, ELEMENT *tmp)
{
  switch (n)
    {
    case 0:
      return;
    case 1:
      /* Nothing to do.  */
      dst[0] = src[0];
      return;
    case 2:
      /* Trivial case.  */
      if (COMPARE (&src[0], &src[1]) <= 0)
        {
          /* src[0] <= src[1] */
          dst[0] = src[0];
          dst[1] = src[1];
        }
      else
        {
          dst[0] = src[1];
          dst[1] = src[0];
        }
      break;
    case 3:
      /* Simple case.  */
      if (COMPARE (&src[0], &src[1]) <= 0)
        {
          if (COMPARE (&src[1], &src[2]) <= 0)
            {
              /* src[0] <= src[1] <= src[2] */
              dst[0] = src[0];
              dst[1] = src[1];
              dst[2] = src[2];
            }
          else if (COMPARE (&src[0], &src[2]) <= 0)
            {
              /* src[0] <= src[2] < src[1] */
              dst[0] = src[0];
              dst[1] = src[2];
              dst[2] = src[1];
            }
          else
            {
              /* src[2] < src[0] <= src[1] */
              dst[0] = src[2];
              dst[1] = src[0];
              dst[2] = src[1];
            }
        }
      else
        {
          if (COMPARE (&src[0], &src[2]) <= 0)
            {
              /* src[1] < src[0] <= src[2] */
              dst[0] = src[1];
              dst[1] = src[0];
              dst[2] = src[2];
            }
          else if (COMPARE (&src[1], &src[2]) <= 0)
            {
              /* src[1] <= src[2] < src[0] */
              dst[0] = src[1];
              dst[1] = src[2];
              dst[2] = src[0];
            }
          else
            {
              /* src[2] < src[1] < src[0] */
              dst[0] = src[2];
              dst[1] = src[1];
              dst[2] = src[0];
            }
        }
      break;
    default:
      {
        size_t n1 = n / 2;
        size_t n2 = (n + 1) / 2;
        /* Note: n1 + n2 = n, n1 <= n2.  */
        /* Sort src[n1..n-1] into dst[n1..n-1], scratching tmp[0..n2/2-1].  */
        merge_sort_fromto (src + n1, dst + n1, n2, tmp);
        /* Sort src[0..n1-1] into tmp[0..n1-1], scratching dst[0..n1-1].  */
        merge_sort_fromto (src, tmp, n1, dst);
        /* Merge the two half results.  */
        merge (tmp, n1, dst + n1, n2, dst);
      }
      break;
    }
}

/* Sort src[0..n-1], using tmp[0..n-1] as temporary (scratch) storage.
   The arrays src, tmp must not overlap. */
STATIC void
merge_sort_inplace (ELEMENT *src, size_t n, ELEMENT *tmp)
{
  switch (n)
    {
    case 0:
    case 1:
      /* Nothing to do.  */
      return;
    case 2:
      /* Trivial case.  */
      if (COMPARE (&src[0], &src[1]) <= 0)
        {
          /* src[0] <= src[1] */
        }
      else
        {
          ELEMENT t = src[0];
          src[0] = src[1];
          src[1] = t;
        }
      break;
    case 3:
      /* Simple case.  */
      if (COMPARE (&src[0], &src[1]) <= 0)
        {
          if (COMPARE (&src[1], &src[2]) <= 0)
            {
              /* src[0] <= src[1] <= src[2] */
            }
          else if (COMPARE (&src[0], &src[2]) <= 0)
            {
              /* src[0] <= src[2] < src[1] */
              ELEMENT t = src[1];
              src[1] = src[2];
              src[2] = t;
            }
          else
            {
              /* src[2] < src[0] <= src[1] */
              ELEMENT t = src[0];
              src[0] = src[2];
              src[2] = src[1];
              src[1] = t;
            }
        }
      else
        {
          if (COMPARE (&src[0], &src[2]) <= 0)
            {
              /* src[1] < src[0] <= src[2] */
              ELEMENT t = src[0];
              src[0] = src[1];
              src[1] = t;
            }
          else if (COMPARE (&src[1], &src[2]) <= 0)
            {
              /* src[1] <= src[2] < src[0] */
              ELEMENT t = src[0];
              src[0] = src[1];
              src[1] = src[2];
              src[2] = t;
            }
          else
            {
              /* src[2] < src[1] < src[0] */
              ELEMENT t = src[0];
              src[0] = src[2];
              src[2] = t;
            }
        }
      break;
    default:
      {
        size_t n1 = n / 2;
        size_t n2 = (n + 1) / 2;
        /* Note: n1 + n2 = n, n1 <= n2.  */
        /* Sort src[n1..n-1], scratching tmp[0..n2-1].  */
        merge_sort_inplace (src + n1, n2, tmp);
        /* Sort src[0..n1-1] into tmp[0..n1-1], scratching tmp[n1..2*n1-1].  */
        merge_sort_fromto (src, tmp, n1, tmp + n1);
        /* Merge the two half results.  */
        merge (tmp, n1, src + n1, n2, src);
      }
      break;
    }
}

#undef ELEMENT
#undef COMPARE
#undef STATIC

Coverage Report

Created: 2026-03-31 07:20

Line	Count	Source
1		/* Stable-sorting of an array using mergesort.
2		Copyright (C) 2009-2026 Free Software Foundation, Inc.
3		Written by Bruno Haible <bruno@clisp.org>, 2009.
4
5		This file is free software: you can redistribute it and/or modify
6		it under the terms of the GNU Lesser General Public License as
7		published by the Free Software Foundation; either version 2.1 of the
8		License, or (at your option) any later version.
9
10		This file is distributed in the hope that it will be useful,
11		but WITHOUT ANY WARRANTY; without even the implied warranty of
12		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		GNU Lesser General Public License for more details.
14
15		You should have received a copy of the GNU Lesser General Public License
16		along with this program. If not, see <https://www.gnu.org/licenses/>. */
17
18		/* This file implements stable sorting of an array, using the mergesort
19		algorithm.
20		Worst-case running time for an array of length N is O(N log N).
21		Unlike the mpsort module, the algorithm here attempts to minimize not
22		only the number of comparisons, but also the number of copying operations.
23
24		Before including this file, you need to define
25		ELEMENT The type of every array element.
26		COMPARE A two-argument macro that takes two 'const ELEMENT *'
27		pointers and returns a negative, zero, or positive 'int'
28		value if the element pointed to by the first argument is,
29		respectively, less, equal, or greater than the element
30		pointed to by the second argument.
31		STATIC The storage class of the functions being defined.
32		STATIC_FROMTO (Optional.) Overrides STATIC for the 'merge_sort_fromto'
33		function.
34		Before including this file, you also need to include:
35		#include <stddef.h>
36		*/
37
38		/* Merge the sorted arrays src1[0..n1-1] and src2[0..n2-1] into
39		dst[0..n1+n2-1]. In case of ambiguity, put the elements of src1
40		before the elements of src2.
41		n1 and n2 must be > 0.
42		The arrays src1 and src2 must not overlap the dst array, except that
43		src1 may be dst[n2..n1+n2-1], or src2 may be dst[n1..n1+n2-1]. */
44		static void
45		merge (const ELEMENT *src1, size_t n1,
46		const ELEMENT *src2, size_t n2,
47		ELEMENT *dst)
48	79.9k	{
49	79.9k	for (;;) /* while (n1 > 0 && n2 > 0) */
50	471k	{
51	471k	if (COMPARE (src1, src2) <= 0)
52	400k	{
53	400k	dst++ = src1++;
54	400k	n1--;
55	400k	if (n1 == 0)
56	74.8k	break;
57	400k	}
58	71.2k	else
59	71.2k	{
60	71.2k	dst++ = src2++;
61	71.2k	n2--;
62	71.2k	if (n2 == 0)
63	5.05k	break;
64	71.2k	}
65	471k	}
66		/* Here n1 == 0 \|\| n2 == 0 but also n1 > 0 \|\| n2 > 0. */
67	79.9k	if (n1 > 0)
68	5.05k	{
69	5.05k	if (dst != src1)
70	5.05k	do
71	8.99k	{
72	8.99k	dst++ = src1++;
73	8.99k	n1--;
74	8.99k	}
75	8.99k	while (n1 > 0);
76	5.05k	}
77	74.8k	else /* n2 > 0 */
78	74.8k	{
79	74.8k	if (dst != src2)
80	0	do
81	0	{
82	0	dst++ = src2++;
83	0	n2--;
84	0	}
85	0	while (n2 > 0);
86	74.8k	}
87	79.9k	}
88
89		/* Sort src[0..n-1] into dst[0..n-1], using tmp[0..n/2-1] as temporary
90		(scratch) storage.
91		The arrays src, dst, tmp must not overlap. */
92		#ifdef STATIC_FROMTO
93		STATIC_FROMTO
94		#else
95		STATIC
96		#endif
97		void
98		merge_sort_fromto (const ELEMENT src, ELEMENT dst, size_t n, ELEMENT *tmp)
99	138k	{
100	138k	switch (n)
101	138k	{
102	0	case 0:
103	0	return;
104	0	case 1:
105		/* Nothing to do. */
106	0	dst[0] = src[0];
107	0	return;
108	68.4k	case 2:
109		/* Trivial case. */
110	68.4k	if (COMPARE (&src[0], &src[1]) <= 0)
111	63.0k	{
112		/* src[0] <= src[1] */
113	63.0k	dst[0] = src[0];
114	63.0k	dst[1] = src[1];
115	63.0k	}
116	5.35k	else
117	5.35k	{
118	5.35k	dst[0] = src[1];
119	5.35k	dst[1] = src[0];
120	5.35k	}
121	68.4k	break;
122	11.5k	case 3:
123		/* Simple case. */
124	11.5k	if (COMPARE (&src[0], &src[1]) <= 0)
125	8.70k	{
126	8.70k	if (COMPARE (&src[1], &src[2]) <= 0)
127	6.19k	{
128		/* src[0] <= src[1] <= src[2] */
129	6.19k	dst[0] = src[0];
130	6.19k	dst[1] = src[1];
131	6.19k	dst[2] = src[2];
132	6.19k	}
133	2.51k	else if (COMPARE (&src[0], &src[2]) <= 0)
134	1.56k	{
135		/* src[0] <= src[2] < src[1] */
136	1.56k	dst[0] = src[0];
137	1.56k	dst[1] = src[2];
138	1.56k	dst[2] = src[1];
139	1.56k	}
140	945	else
141	945	{
142		/* src[2] < src[0] <= src[1] */
143	945	dst[0] = src[2];
144	945	dst[1] = src[0];
145	945	dst[2] = src[1];
146	945	}
147	8.70k	}
148	2.79k	else
149	2.79k	{
150	2.79k	if (COMPARE (&src[0], &src[2]) <= 0)
151	1.16k	{
152		/* src[1] < src[0] <= src[2] */
153	1.16k	dst[0] = src[1];
154	1.16k	dst[1] = src[0];
155	1.16k	dst[2] = src[2];
156	1.16k	}
157	1.63k	else if (COMPARE (&src[1], &src[2]) <= 0)
158	889	{
159		/* src[1] <= src[2] < src[0] */
160	889	dst[0] = src[1];
161	889	dst[1] = src[2];
162	889	dst[2] = src[0];
163	889	}
164	745	else
165	745	{
166		/* src[2] < src[1] < src[0] */
167	745	dst[0] = src[2];
168	745	dst[1] = src[1];
169	745	dst[2] = src[0];
170	745	}
171	2.79k	}
172	11.5k	break;
173	58.1k	default:
174	58.1k	{
175	58.1k	size_t n1 = n / 2;
176	58.1k	size_t n2 = (n + 1) / 2;
177		/* Note: n1 + n2 = n, n1 <= n2. */
178		/* Sort src[n1..n-1] into dst[n1..n-1], scratching tmp[0..n2/2-1]. */
179	58.1k	merge_sort_fromto (src + n1, dst + n1, n2, tmp);
180		/* Sort src[0..n1-1] into tmp[0..n1-1], scratching dst[0..n1-1]. */
181	58.1k	merge_sort_fromto (src, tmp, n1, dst);
182		/* Merge the two half results. */
183	58.1k	merge (tmp, n1, dst + n1, n2, dst);
184	58.1k	}
185	58.1k	break;
186	138k	}
187	138k	}
188
189		/* Sort src[0..n-1], using tmp[0..n-1] as temporary (scratch) storage.
190		The arrays src, tmp must not overlap. */
191		STATIC void
192		merge_sort_inplace (ELEMENT src, size_t n, ELEMENT tmp)
193	41.2k	{
194	41.2k	switch (n)
195	41.2k	{
196	0	case 0:
197	0	case 1:
198		/* Nothing to do. */
199	0	return;
200	23.3k	case 2:
201		/* Trivial case. */
202	23.3k	if (COMPARE (&src[0], &src[1]) <= 0)
203	22.7k	{
204		/* src[0] <= src[1] */
205	22.7k	}
206	643	else
207	643	{
208	643	ELEMENT t = src[0];
209	643	src[0] = src[1];
210	643	src[1] = t;
211	643	}
212	23.3k	break;
213	6.78k	case 3:
214		/* Simple case. */
215	6.78k	if (COMPARE (&src[0], &src[1]) <= 0)
216	5.43k	{
217	5.43k	if (COMPARE (&src[1], &src[2]) <= 0)
218	4.64k	{
219		/* src[0] <= src[1] <= src[2] */
220	4.64k	}
221	787	else if (COMPARE (&src[0], &src[2]) <= 0)
222	350	{
223		/* src[0] <= src[2] < src[1] */
224	350	ELEMENT t = src[1];
225	350	src[1] = src[2];
226	350	src[2] = t;
227	350	}
228	437	else
229	437	{
230		/* src[2] < src[0] <= src[1] */
231	437	ELEMENT t = src[0];
232	437	src[0] = src[2];
233	437	src[2] = src[1];
234	437	src[1] = t;
235	437	}
236	5.43k	}
237	1.35k	else
238	1.35k	{
239	1.35k	if (COMPARE (&src[0], &src[2]) <= 0)
240	526	{
241		/* src[1] < src[0] <= src[2] */
242	526	ELEMENT t = src[0];
243	526	src[0] = src[1];
244	526	src[1] = t;
245	526	}
246	828	else if (COMPARE (&src[1], &src[2]) <= 0)
247	539	{
248		/* src[1] <= src[2] < src[0] */
249	539	ELEMENT t = src[0];
250	539	src[0] = src[1];
251	539	src[1] = src[2];
252	539	src[2] = t;
253	539	}
254	289	else
255	289	{
256		/* src[2] < src[1] < src[0] */
257	289	ELEMENT t = src[0];
258	289	src[0] = src[2];
259	289	src[2] = t;
260	289	}
261	1.35k	}
262	6.78k	break;
263	11.0k	default:
264	11.0k	{
265	11.0k	size_t n1 = n / 2;
266	11.0k	size_t n2 = (n + 1) / 2;
267		/* Note: n1 + n2 = n, n1 <= n2. */
268		/* Sort src[n1..n-1], scratching tmp[0..n2-1]. */
269	11.0k	merge_sort_inplace (src + n1, n2, tmp);
270		/* Sort src[0..n1-1] into tmp[0..n1-1], scratching tmp[n1..2n1-1]. /
271	11.0k	merge_sort_fromto (src, tmp, n1, tmp + n1);
272		/* Merge the two half results. */
273	11.0k	merge (tmp, n1, src + n1, n2, src);
274	11.0k	}
275	11.0k	break;
276	41.2k	}
277	41.2k	}
278
279		#undef ELEMENT
280		#undef COMPARE
281		#undef STATIC