8f913b6793186335504b952aa8add7af3f29b91dvboxsync * IPRT - Sorting.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2011 Oracle Corporation
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * available from http://www.virtualbox.org. This file is free software;
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * General Public License (GPL) as published by the Free Software
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * The contents of this file may alternatively be used under the terms
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * of the Common Development and Distribution License Version 1.0
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * CDDL are applicable instead of those of the GPL.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * You may elect to license modified versions of this file under the
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * terms and conditions of either the GPL or the CDDL or both.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync/** @defgroup grp_rt_sort RTSort - Sorting Algorithms
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @ingroup grp_rt
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Callback for comparing two array elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @retval 0 if equal.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @retval -1 if @a pvElement1 comes before @a pvElement2.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @retval 1 if @a pvElement1 comes after @a pvElement2.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvElement1 The 1st element.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvElement2 The 2nd element.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser The user argument passed to the sorting function.
8f913b6793186335504b952aa8add7af3f29b91dvboxsynctypedef DECLCALLBACK(int) FNRTSORTCMP(void const *pvElement1, void const *pvElement2, void *pvUser);
8f913b6793186335504b952aa8add7af3f29b91dvboxsync/** Pointer to a compare function. */
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Sorter function for an array of variable sized elementes.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param papvArray The array to sort.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cElements The number of elements in the array.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cbElements The size of an array element.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pfnCmp Callback function comparing two elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser User argument for the callback.
8f913b6793186335504b952aa8add7af3f29b91dvboxsynctypedef DECLCALLBACK(void) FNRTSORT(void *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
8f913b6793186335504b952aa8add7af3f29b91dvboxsync/** Pointer to a sorter function for an array of variable sized elements. */
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Pointer array sorter function.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param papvArray The array to sort.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cElements The number of elements in the array.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pfnCmp Callback function comparing two elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser User argument for the callback.
8f913b6793186335504b952aa8add7af3f29b91dvboxsynctypedef DECLCALLBACK(void) FNRTSORTAPV(void **papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
8f913b6793186335504b952aa8add7af3f29b91dvboxsync/** Pointer to a pointer array sorter function. */
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Shell sort an array of variable sized elementes.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param papvArray The array to sort.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cElements The number of elements in the array.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cbElements The size of an array element.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pfnCmp Callback function comparing two elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser User argument for the callback.
8f913b6793186335504b952aa8add7af3f29b91dvboxsyncRTDECL(void) RTSortShell(void *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Same as RTSortShell but speciallized for an array containing element
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * pointers.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param papvArray The array to sort.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cElements The number of elements in the array.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pfnCmp Callback function comparing two elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser User argument for the callback.
8f913b6793186335504b952aa8add7af3f29b91dvboxsyncRTDECL(void) RTSortApvShell(void **papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Checks if an array of variable sized elementes is sorted.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @returns true if it is sorted, false if it isn't.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param papvArray The array to check.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cElements The number of elements in the array.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cbElements The size of an array element.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pfnCmp Callback function comparing two elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser User argument for the callback.
8f913b6793186335504b952aa8add7af3f29b91dvboxsyncRTDECL(bool) RTSortIsSorted(void const *pvArray, size_t cElements, size_t cbElement, PFNRTSORTCMP pfnCmp, void *pvUser);
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * Same as RTSortShell but speciallized for an array containing element
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * pointers.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @returns true if it is sorted, false if it isn't.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param papvArray The array to check.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param cElements The number of elements in the array.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pfnCmp Callback function comparing two elements.
8f913b6793186335504b952aa8add7af3f29b91dvboxsync * @param pvUser User argument for the callback.
8f913b6793186335504b952aa8add7af3f29b91dvboxsyncRTDECL(bool) RTSortApvIsSorted(void const * const *papvArray, size_t cElements, PFNRTSORTCMP pfnCmp, void *pvUser);