VirtualBox

source: vbox/trunk/include/iprt/sort.h@ 33826

Last change on this file since 33826 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.7 KB
Line 
1/** @file
2 * IPRT - Sorting.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_sort_h
27#define ___iprt_sort_h
28
29#include <iprt/types.h>
30
31/** @defgroup grp_rt_sort RTSort - Sorting Algorithms
32 * @ingroup grp_rt
33 * @{ */
34
35/**
36 * Callback for comparing two array elements.
37 *
38 * @retval 0 if equal.
39 * @retval -1 if @a pvElement1 comes before @a pvElement2.
40 * @retval 1 if @a pvElement1 comes after @a pvElement2.
41 *
42 * @param pvElement1 The 1st element.
43 * @param pvElement2 The 2nd element.
44 * @param pvUser The user argument passed to the sorting function.
45 */
46typedef DECLCALLBACK(int) FNRTSORTCMP(void const *pvElement1, void const *pvElement2, void *pvUser);
47/** Pointer to a compare function. */
48typedef FNRTSORTCMP *PFNRTSORTCMP;
49
50/**
51 * Sorter function for an array of variable sized elementes.
52 *
53 * @param papvArray The array to sort.
54 * @param cElements The number of elements in the array.
55 * @param cbElements The size of an array element.
56 * @param pfnCmp Callback function comparing two elements.
57 * @param pvUser User argument for the callback.
58 */
59typedef DECLCALLBACK(void) FNRTSORT(void *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
60/** Pointer to a sorter function for an array of variable sized elements. */
61typedef FNRTSORT *PFNRTSORT;
62
63/**
64 * Pointer array sorter function.
65 *
66 * @param papvArray The array to sort.
67 * @param cElements The number of elements in the array.
68 * @param pfnCmp Callback function comparing two elements.
69 * @param pvUser User argument for the callback.
70 */
71typedef DECLCALLBACK(void) FNRTSORTAPV(void **papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
72/** Pointer to a pointer array sorter function. */
73typedef FNRTSORTAPV *PFNRTSORTAPV;
74
75/**
76 * Shell sort an array of variable sized elementes.
77 *
78 * @param papvArray The array to sort.
79 * @param cElements The number of elements in the array.
80 * @param cbElements The size of an array element.
81 * @param pfnCmp Callback function comparing two elements.
82 * @param pvUser User argument for the callback.
83 */
84RTDECL(void) RTSortShell(void *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
85
86/**
87 * Same as RTSortShell but speciallized for an array containing element
88 * pointers.
89 *
90 * @param papvArray The array to sort.
91 * @param cElements The number of elements in the array.
92 * @param pfnCmp Callback function comparing two elements.
93 * @param pvUser User argument for the callback.
94 */
95RTDECL(void) RTSortApvShell(void **papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
96
97/**
98 * Checks if an array of variable sized elementes is sorted.
99 *
100 * @returns true if it is sorted, false if it isn't.
101 * @param papvArray The array to check.
102 * @param cElements The number of elements in the array.
103 * @param cbElements The size of an array element.
104 * @param pfnCmp Callback function comparing two elements.
105 * @param pvUser User argument for the callback.
106 */
107RTDECL(bool) RTSortIsSorted(void const *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
108
109/**
110 * Same as RTSortShell but speciallized for an array containing element
111 * pointers.
112 *
113 * @returns true if it is sorted, false if it isn't.
114 * @param papvArray The array to check.
115 * @param cElements The number of elements in the array.
116 * @param pfnCmp Callback function comparing two elements.
117 * @param pvUser User argument for the callback.
118 */
119RTDECL(bool) RTSortApvIsSorted(void const * const *papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
120
121
122/** @} */
123
124#endif
125
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette