1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/** @file
* IPRT - Sorting.
*/
/*
* Copyright (C) 2006-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef IPRT_INCLUDED_sort_h
#define IPRT_INCLUDED_sort_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/types.h>
/** @defgroup grp_rt_sort RTSort - Sorting Algorithms
* @ingroup grp_rt
* @{ */
RT_C_DECLS_BEGIN
/**
* Callback for comparing two array elements.
*
* @retval 0 if equal.
* @retval -1 if @a pvElement1 comes before @a pvElement2.
* @retval 1 if @a pvElement1 comes after @a pvElement2.
*
* @param pvElement1 The 1st element.
* @param pvElement2 The 2nd element.
* @param pvUser The user argument passed to the sorting function.
*/
typedef DECLCALLBACKTYPE(int, FNRTSORTCMP,(void const *pvElement1, void const *pvElement2, void *pvUser));
/** Pointer to a compare function. */
typedef FNRTSORTCMP *PFNRTSORTCMP;
/**
* Sorter function for an array of variable sized elementes.
*
* @param pvArray The array to sort.
* @param cElements The number of elements in the array.
* @param cbElement The size of an array element.
* @param pfnCmp Callback function comparing two elements.
* @param pvUser User argument for the callback.
*/
typedef DECLCALLBACKTYPE(void, FNRTSORT,(void *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser));
/** Pointer to a sorter function for an array of variable sized elements. */
typedef FNRTSORT *PFNRTSORT;
/**
* Pointer array sorter function.
*
* @param papvArray The array to sort.
* @param cElements The number of elements in the array.
* @param pfnCmp Callback function comparing two elements.
* @param pvUser User argument for the callback.
*/
typedef DECLCALLBACKTYPE(void, FNRTSORTAPV,(void **papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser));
/** Pointer to a pointer array sorter function. */
typedef FNRTSORTAPV *PFNRTSORTAPV;
/**
* Shell sort an array of variable sized elementes.
*
* @param pvArray The array to sort.
* @param cElements The number of elements in the array.
* @param cbElement The size of an array element.
* @param pfnCmp Callback function comparing two elements.
* @param pvUser User argument for the callback.
*/
RTDECL(void) RTSortShell(void *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
/**
* Same as RTSortShell but speciallized for an array containing element
* pointers.
*
* @param papvArray The array to sort.
* @param cElements The number of elements in the array.
* @param pfnCmp Callback function comparing two elements.
* @param pvUser User argument for the callback.
*/
RTDECL(void) RTSortApvShell(void **papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
/**
* Checks if an array of variable sized elementes is sorted.
*
* @returns true if it is sorted, false if it isn't.
* @param pvArray The array to check.
* @param cElements The number of elements in the array.
* @param cbElement The size of an array element.
* @param pfnCmp Callback function comparing two elements.
* @param pvUser User argument for the callback.
*/
RTDECL(bool) RTSortIsSorted(void const *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
/**
* Same as RTSortShell but speciallized for an array containing element
* pointers.
*
* @returns true if it is sorted, false if it isn't.
* @param papvArray The array to check.
* @param cElements The number of elements in the array.
* @param pfnCmp Callback function comparing two elements.
* @param pvUser User argument for the callback.
*/
RTDECL(bool) RTSortApvIsSorted(void const * const *papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
RT_C_DECLS_END
/** @} */
#endif /* !IPRT_INCLUDED_sort_h */
|
