More copyright header updates
[alexxy/gromacs.git] / src / gromacs / legacyheaders / gmx_sort.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2010,2012, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35 /*! \internal \file
36  * \brief
37  * Portable implementation of thread-safe sort routines.
38  *
39  * This module provides a Gromacs version of the qsort() routine defined.
40  * It is not highly optimized, but it is thread safe, i.e. multiple threads
41  * can simultaneously call gmx_qsort() with different data.
42  *
43  * The rational is that some implementations of qsort() are not threadsafe.
44  * For instance qsort in glibc contains a bug which makes it non-threadsafe:
45  * http://sources.redhat.com/bugzilla/show_bug.cgi?id=11655
46  * On the other hand, system qsort might be faster than our own.
47  */
48 #ifndef GMX_SORT_H
49 #define GMX_SORT_H
50
51 #include <stdlib.h>
52
53 #ifdef __cplusplus
54 extern "C"
55 {
56 #endif
57 #if 0
58 } /* fixes auto-indentation problems */
59 #endif
60
61 /*! \brief
62  * Portable thread-safe sort routine.
63  *
64  * \param base    Pointer to first element in list to sort
65  * \param nmemb   Number of elements in list
66  * \param size    Size in bytes of each element
67  * \param compar  Comparison function that takes two pointers to elements
68  *                being compared as arguments.  The function should return an
69  *                integer less than, equal to, or greater than zero if the
70  *                first argument is considered to be respectively less than,
71  *                equal to, or greater than the second.
72  */
73 void
74 gmx_qsort(void *           base,
75           size_t           nmemb,
76           size_t           size,
77           int            (*compar)(const void *, const void *));
78
79
80 /*! \def qsort_threadsafe
81  * \brief
82  * Thread-safe qsort.
83  *
84  * Expands to gmx_qsort() if Gromacs is built with threading, or system qsort()
85  * otherwise.
86  */
87 #ifdef GMX_THREAD_MPI
88 #define qsort_threadsafe gmx_qsort
89 #else
90 #define qsort_threadsafe qsort
91 #endif
92
93 #ifdef __cplusplus
94 }
95 #endif
96
97 #endif /* GMX_SORT_H */