Changeset 833dd90 in rtems for cpukit/sapi
- Timestamp:
- 11/19/13 15:09:39 (10 years ago)
- Branches:
- 4.11, 5, master
- Children:
- 4ea97d24
- Parents:
- eea7c937
- git-author:
- Sebastian Huber <sebastian.huber@…> (11/19/13 15:09:39)
- git-committer:
- Sebastian Huber <sebastian.huber@…> (11/21/13 11:58:46)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
cpukit/sapi/include/rtems/rbtree.h
reea7c937 r833dd90 310 310 } 311 311 312 /** @brief Find the node with given key in the tree.313 *314 * This function returns a pointer to the node having key equal to the key315 * of @a the_node if it exists within @a the_rbtree, and NULL if not.316 * @a the_node has to be made up before a search.317 *318 * @note If the tree is not unique and contains duplicate keys, the set319 * of duplicate keys acts as FIFO.320 */321 RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_find(322 const rtems_rbtree_control *the_rbtree,323 const rtems_rbtree_node *the_node324 )325 {326 return _RBTree_Find( the_rbtree, the_node );327 }328 329 312 /** 330 313 * @copydoc _RBTree_Predecessor_unprotected() … … 338 321 339 322 /** 340 * @copydoc _RBTree_Predecessor()341 */342 RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_predecessor(343 const rtems_rbtree_node *node344 )345 {346 return _RBTree_Predecessor( node );347 }348 349 /**350 323 * @copydoc _RBTree_Successor_unprotected() 351 324 */ … … 355 328 { 356 329 return _RBTree_Successor_unprotected( node ); 357 }358 359 /**360 * @copydoc _RBTree_Successor()361 */362 RTEMS_INLINE_ROUTINE rtems_rbtree_node* rtems_rbtree_successor(363 const rtems_rbtree_node *node364 )365 {366 return _RBTree_Successor( node );367 330 } 368 331 … … 379 342 380 343 /** 381 * @brief Extract the specified node from a rbtree.382 *383 * This routine extracts @a the_node from @a the_rbtree on which it resides.384 * It disables interrupts to ensure the atomicity of the extract operation.385 */386 RTEMS_INLINE_ROUTINE void rtems_rbtree_extract(387 rtems_rbtree_control *the_rbtree,388 rtems_rbtree_node *the_node389 )390 {391 _RBTree_Extract( the_rbtree, the_node );392 }393 394 /**395 344 * @brief Obtain the min node on a rbtree. 396 345 * … … 407 356 408 357 /** 409 * @brief Obtain the min node on a rbtree.410 *411 * This function removes the min node from @a the_rbtree and returns412 * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.413 * It disables interrupts to ensure the atomicity of the get operation.414 */415 RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_min(416 rtems_rbtree_control *the_rbtree417 )418 {419 return _RBTree_Get( the_rbtree, RBT_LEFT );420 }421 422 /**423 358 * @brief Obtain the max node on a rbtree. 424 359 * … … 432 367 { 433 368 return _RBTree_Get_unprotected( the_rbtree, RBT_RIGHT ); 434 }435 436 /**437 * @brief Obtain the max node on a rbtree.438 *439 * This function removes the max node from @a the_rbtree and returns440 * a pointer to that node. If @a the_rbtree is empty, then NULL is returned.441 * It disables interrupts to ensure the atomicity of the get operation.442 */443 RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_get_max(444 rtems_rbtree_control *the_rbtree445 )446 {447 return _RBTree_Get( the_rbtree, RBT_RIGHT );448 369 } 449 370 … … 487 408 488 409 /** 489 * @brief Find the control header of the tree containing a given node.490 *491 * This routine finds the rtems_rbtree_control structure of the tree492 * containing @a the_node.493 * It disables interrupts to ensure the atomicity of the find operation.494 */495 RTEMS_INLINE_ROUTINE rtems_rbtree_control *rtems_rbtree_find_header(496 rtems_rbtree_node *the_node497 )498 {499 return _RBTree_Find_header( the_node );500 }501 502 /**503 410 * @copydoc _RBTree_Insert_unprotected() 504 411 */ … … 511 418 } 512 419 513 /**514 * @brief Insert a node on a rbtree.515 *516 * This routine inserts @a the_node on @a the_rbtree.517 * It disables interrupts to ensure the atomicity of the insert operation.518 *519 * @retval 0 Successfully inserted.520 * @retval -1 NULL @a the_node.521 * @retval RBTree_Node* if one with equal key to the key of @a the_node exists522 * in an unique @a the_rbtree.523 */524 RTEMS_INLINE_ROUTINE rtems_rbtree_node *rtems_rbtree_insert(525 rtems_rbtree_control *the_rbtree,526 rtems_rbtree_node *the_node527 )528 {529 return _RBTree_Insert( the_rbtree, the_node );530 }531 532 420 /** 533 421 * @brief Determines whether the tree is unique.
Note: See TracChangeset
for help on using the changeset viewer.