blob: ed4cbd558ab446fd4d796f717a8c7f5c08a747bd (
plain) (
blame)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/**
* @file
*
* @brief Inlined Routines Associated with Red-Black Trees
*
* This include file contains the bodies of the routines which are
* associated with Red-Black Trees and inlined.
*
* @note The routines in this file are ordered from simple
* to complex. No other RBTree Handler routine is referenced
* unless it has already been defined.
*/
/*
* Copyright (c) 2010-2012 Gedare Bloom.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _RTEMS_SCORE_RBTREEIMPL_H
#define _RTEMS_SCORE_RBTREEIMPL_H
#include <rtems/score/rbtree.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup ScoreRBTree
*/
/**@{**/
/**
* @brief Red-black tree visitor.
*
* @param[in] node The node.
* @param[in] dir The direction.
* @param[in] visitor_arg The visitor argument.
*
* @retval true Stop the iteration.
* @retval false Continue the iteration.
*
* @see _RBTree_Iterate().
*/
typedef bool (*RBTree_Visitor)(
const RBTree_Node *node,
RBTree_Direction dir,
void *visitor_arg
);
/**
* @brief Red-black tree iteration.
*
* @param[in] rbtree The red-black tree.
* @param[in] dir The direction.
* @param[in] visitor The visitor.
* @param[in] visitor_arg The visitor argument.
*/
void _RBTree_Iterate(
const RBTree_Control *rbtree,
RBTree_Direction dir,
RBTree_Visitor visitor,
void *visitor_arg
);
/**
* @brief Get the direction opposite to @a the_dir.
*/
RTEMS_INLINE_ROUTINE RBTree_Direction _RBTree_Opposite_direction(
RBTree_Direction the_dir
)
{
return (RBTree_Direction) !((int) the_dir);
}
/**
* @brief Returns the direction of the node.
*
* @param[in] the_node The node of interest.
* @param[in] parent The parent of the node. The parent must exist, thus it is
* invalid to use this function for the root node.
*/
RTEMS_INLINE_ROUTINE RBTree_Direction _RBTree_Direction(
const RBTree_Node *the_node,
const RBTree_Node *parent
)
{
return (RBTree_Direction) ( the_node != parent->child[ 0 ] );
}
/**
* @brief Is this node red.
*
* This function returns true if @a the_node is red and false otherwise.
*
* @retval true @a the_node is red.
* @retval false @a the_node in not red.
*/
RTEMS_INLINE_ROUTINE bool _RBTree_Is_red(
const RBTree_Node *the_node
)
{
return (the_node && the_node->color == RBT_RED);
}
/**
* @brief Returns the sibling of the node.
*
* @param[in] the_node The node of interest.
* @param[in] parent The parent of the node. The parent must exist, thus it is
* invalid to use this function for the root node.
*
* @retval NULL No sibling exists.
* @retval sibling The sibling of the node.
*/
RTEMS_INLINE_ROUTINE RBTree_Node *_RBTree_Sibling(
const RBTree_Node *the_node,
const RBTree_Node *parent
)
{
RBTree_Node *left_child = parent->child[ RBT_LEFT ];
return the_node == left_child ? parent->child[ RBT_RIGHT ] : left_child;
}
RTEMS_INLINE_ROUTINE bool _RBTree_Is_equal(
RBTree_Compare_result compare_result
)
{
return compare_result == 0;
}
RTEMS_INLINE_ROUTINE bool _RBTree_Is_greater(
RBTree_Compare_result compare_result
)
{
return compare_result > 0;
}
RTEMS_INLINE_ROUTINE bool _RBTree_Is_lesser(
RBTree_Compare_result compare_result
)
{
return compare_result < 0;
}
/**
* @brief Rotates the node in the specified direction.
*
* The node is swapped with its child in the opposite direction if it exists.
*
* Sub-tree before rotation:
* @dot
* digraph state {
* parent -> the_node;
* the_node -> sibling [label="dir"];
* the_node -> child [label="opp_dir"];
* child -> grandchild [label="dir"];
* child -> grandchildsibling [label="opp_dir"];
* }
* @enddot
*
* Sub-tree after rotation:
* @dot
* digraph state {
* parent -> child;
* the_node -> sibling [label="dir"];
* the_node -> grandchild [label="opp_dir"];
* child -> the_node [label="dir"];
* child -> grandchildsibling [label="opp_dir"];
* }
* @enddot
*
* @param[in] the_node The node to rotate.
* @param[in] dir The rotation direction.
*/
RTEMS_INLINE_ROUTINE void _RBTree_Rotate(
RBTree_Node *the_node,
RBTree_Direction dir
)
{
RBTree_Direction opp_dir = _RBTree_Opposite_direction( dir );
RBTree_Node *child = the_node->child[ opp_dir ];
RBTree_Node *grandchild;
RBTree_Node *parent;
if ( child == NULL)
return;
grandchild = child->child[ dir ];
the_node->child[ opp_dir ] = grandchild;
if ( grandchild != NULL )
grandchild->parent = the_node;
child->child[ dir ] = the_node;
parent = _RBTree_Parent( the_node );
parent->child[ _RBTree_Direction( the_node, parent ) ] = child;
child->parent = parent;
the_node->parent = child;
}
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
