aboutsummaryrefslogtreecommitdiff
path: root/include/BH/Algo.h
blob: 2164c156958372675584ae292c4287c7f1e002fd (plain)
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
#ifndef BH_ALGO_H
#define BH_ALGO_H


#include "Common.h"


/**
 * Exchanges values between \a src and \a dest elements of sizze \a size.
 *
 * \param dest  Destination element pointer
 * \param src   Source element pointer
 * \param size  Element size in bytes
 */
void BH_Swap(void *dest,
             void *src,
             size_t size);


/**
 * Partitions the \a array (with specified \a size and \a element size)
 * relative to specified \a pivot element.
 *
 * The \a pivot element can be part of the partitioned \a array.
 *
 * \param pivot    Pivot element pointer
 * \param array    Array pointer
 * \param size     Array size
 * \param element  Array element size
 * \param equal    Comparision function
 *
 * \return Pointer to the first element of the second partition.
 */
void *BH_Partition(void *pivot,
                   void *array,
                   size_t size,
                   size_t element,
                   BH_EqualCallback equal);


/**
 * Sorts the \a array (with specified \a size and \a element size).
 *
 * The sorting algorithm is implementation defined and may change between
 * revisions.
 *
 * \param array    Array pointer
 * \param size     Array size
 * \param element  Array element size
 * \param equal    Comparision function
 */
void BH_Sort(void *array,
             size_t size,
             size_t element,
             BH_EqualCallback equal);


/**
 * Heapifies an \a array (with specified \a size and \a element size).
 *
 * \param array    Array pointer
 * \param size     Array size
 * \param element  Array element size
 * \param equal    Comparision function
 */
void BH_HeapMake(void *array,
                 size_t size,
                 size_t element,
                 BH_EqualCallback equal);


/**
 * Removes top value from the heapified \a array (with specified \a size
 * and \a element size).
 *
 * \param array     Array pointer
 * \param size      Array size
 * \param element   Array element size
 * \param equal     Comparasion function
 */
void BH_HeapRemove(void *array,
                   size_t size,
                   size_t element,
                   BH_EqualCallback equal);


/**
 * Inserts new \a value into heapified \a array in an array (with specified
 * \a size and \a element size)
 *
 * If \a value pointer is NULL, it is assumed that new value is placed at the
 * end of the array.
 *
 * \param value    Value pointer
 * \param array    Array pointer
 * \param size     Array size
 * \param element  Array element size
 * \param equal    Comparasion function
 */
void BH_HeapInsert(void *value,
                   void *array,
                   size_t size,
                   size_t element,
                   BH_EqualCallback equal);


/**
 * Removes top value from heapified \a array (with specified \a size and
 * \a element size) and inserts new \a value.
 *
 * If value pointer is NULL, it is assumed that new value is placed at the
 * end of the array.
 *
 * \param value    Value pointer
 * \param array    Array pointer
 * \param size     Array size
 * \param element  Array element size
 * \param equal    Comparasion function
 */
void BH_HeapReplace(void *value,
                    void *array,
                    size_t size,
                    size_t element,
                    BH_EqualCallback equal);


#endif /* BH_ALGO_H */