dvander@535: /**
dvander@535:  * vim: set ts=4 :
dvander@535:  * ===============================================================
dvander@535:  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@535:  * ===============================================================
dvander@535:  *
dvander@535:  *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be used 
dvander@535:  * or modified under the Terms and Conditions of its License Agreement, which is found 
dvander@535:  * in LICENSE.txt.  The Terms and Conditions for making SourceMod extensions/plugins 
dvander@535:  * may change at any time.  To view the latest information, see:
dvander@535:  *   http://www.sourcemod.net/license.php
dvander@535:  *
dvander@535:  * Version: $Id$
dvander@535:  */
dvander@535: 
dvander@535: 
dvander@535: #if defined _sorting_included
dvander@535:   #endinput
dvander@535: #endif
dvander@535: #define _sorting_included
dvander@535: 
dvander@535: /**
dvander@619:  * Contains sorting orders.
dvander@535:  */
dvander@535: enum SortOrder
dvander@535: {
dvander@535: 	Sort_Ascending = 0,		/**< Ascending order */
dvander@535: 	Sort_Descending = 1,	/**< Descending order */
dvander@535: };
dvander@535: 
dvander@535: /**
dvander@535:  * Sorts an array of integers.
dvander@535:  *
dvander@535:  * @param array			Array of integers to sort in-place.
dvander@535:  * @param array_size	Size of the array.
dvander@535:  * @param order			Sorting order to use.
dvander@535:  * @noreturn
dvander@535:  */
dvander@535: native SortIntegers(array[], array_size, SortOrder:order = Sort_Ascending);
dvander@535: 
dvander@535: /**
dvander@535:  * Sorts an array of float point numbers.
dvander@535:  *
dvander@535:  * @param array			Array of floating point numbers to sort in-place.
dvander@535:  * @param array_size	Size of the array.
dvander@535:  * @param order			Sorting order to use.
dvander@535:  * @noreturn
dvander@535:  */
dvander@535: native SortFloats(Float:array[], array_size, SortOrder:order = Sort_Ascending);
dvander@535: 
dvander@535: /**
dvander@535:  * Sorts an array of strings.
dvander@535:  *
dvander@535:  * @param array			Array of strings to sort in-place.
dvander@535:  * @param array_size	Size of the array.
dvander@535:  * @param order			Sorting order to use.
dvander@535:  * @noreturn
dvander@535:  */
dvander@535: native SortStrings(String:array[][], num_strings, SortOrder:order = Sort_Ascending);
dvander@535: 
dvander@535: /**
dvander@535:  * Sort comparison function for 1D array elements.
dvander@535:  * @note You may need to use explicit tags in order to use data properly.
dvander@535:  *
dvander@535:  * @param elem1			First element to compare.
dvander@535:  * @param elem2			Second element to compare.
dvander@535:  * @param array			Array that is being sorted (order is undefined).
dvander@535:  * @param hndl			Handle optionally passed in while sorting.
dvander@535:  * @return				-1 if first should go before second
dvander@535:  *						0 if first is equal to second
dvander@535:  *						1 if first should go after second
dvander@535:  */
dvander@535: functag SortFunc1D public(elem1, elem2, const array[], Handle:hndl);
dvander@535: 
dvander@535: /** 
dvander@535:  * Sorts a custom 1D array.  You must pass in a comparison function.
dvander@535:  *
dvander@535:  * @param array			Array to sort.
dvander@535:  * @param array_size	Size of the array to sort.
dvander@535:  * @param sortfunc		Sort function.
dvander@535:  * @param hndl			Optional Handle to pass through the comparison calls.
dvander@535:  * @noreturn
dvander@535:  */
dvander@535: native SortCustom1D(array[], array_size, SortFunc1D:sortfunc, Handle:hndl=INVALID_HANDLE);
dvander@535: 
dvander@535: /**
dvander@535:  * Sort comparison function for 2D array elements (sub-arrays).
dvander@535:  * @note You may need to use explicit tags in order to use data properly.
dvander@535:  *
dvander@535:  * @param elem1			First array to compare.
dvander@535:  * @param elem2			Second array to compare.
dvander@535:  * @param array			Array that is being sorted (order is undefined).
dvander@535:  * @param hndl			Handle optionally passed in while sorting.
dvander@535:  * @return				-1 if first should go before second
dvander@535:  *						0 if first is equal to second
dvander@535:  *						1 if first should go after second
dvander@535:  */
dvander@535: funcenum SortFunc2D
dvander@535: {
dvander@535: 	public(array[], array[], const array[][], Handle:hndl),
dvander@535: 	public(String:array[], String:array[], const String:array[][], Handle:hndl),
dvander@535: };
dvander@535: 
dvander@535: /** 
dvander@535:  * Sorts a custom 2D array.  You must pass in a comparison function.
dvander@535:  *
dvander@535:  * @param array			Array to sort.
dvander@535:  * @param array_size	Size of the major array to sort (first index, outermost).
dvander@535:  * @param sortfunc		Sort comparison function to use.
dvander@535:  * @param hndl			Optional Handle to pass through the comparison calls.
dvander@535:  * @noreturn
dvander@535:  */
ds@634: native SortCustom2D(array[][], array_size, SortFunc2D:sortfunc, Handle:hndl=INVALID_HANDLE);