archive/archived
Archived
1
0
Fork 0
Code Activity

docs/rbtree.txt: changed indent on data structure section.

Browse source
This commit is contained in:
Henrik Hautakoski 2010-11-14 11:24:51 +01:00
parent 546a78ad76
commit 4bf08bdc7f
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/rbtree.txt
View file

@ -22,7 +22,8 @@ Data structures
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
* `rbnode` * `rbnode`
+
--
The binary tree node. The binary tree node.
`key`:: `key`::
@ -30,18 +31,20 @@ The binary tree node.
`data`:: `data`::
pointer to the data associated with the key pointer to the data associated with the key
`child`:: `child`::
pointers to the left and right child to this node pointers to the left and right child to this node
`color`:: `color`::
the color, should be a value of `RB_BLACK` or `RB_RED` the color, should be a value of `RB_BLACK` or `RB_RED`
--
++++ ++++
++++ ++++
* `rbtree` * `rbtree`
+
--
Structure that holds a tree of nodes Structure that holds a tree of nodes
`root`:: `root`::
@ -59,6 +62,7 @@ NOTE: You may only need this if you store the data in another structure and has
`cmp_fn`:: `cmp_fn`::
Pointer to the function that is used to compare `rbnode->data` pointers. + Pointer to the function that is used to compare `rbnode->data` pointers. +
Shall return a value greater than zero if 'ptr1' > 'ptr2', a value less than zero if 'ptr1' < 'ptr2' and zero if 'ptr1' == 'ptr2'. Shall return a value greater than zero if 'ptr1' > 'ptr2', a value less than zero if 'ptr1' < 'ptr2' and zero if 'ptr1' == 'ptr2'.
--
Functions Functions
~~~~~~~~~ ~~~~~~~~~