From 6e5181e4056b247bf7c092645c02e748ff9dd7a9 Mon Sep 17 00:00:00 2001 From: Patrick Pelissier Date: Thu, 2 Jul 2020 23:22:44 +0200 Subject: [PATCH] Fix doc on B+TREE --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6fbe5bb4..240a5aef 100644 --- a/README.md +++ b/README.md @@ -2913,10 +2913,17 @@ In the following methods, name stands for the name given to the macro that is us Type of the B+Tree of 'type'. -##### name\_it_\_t +##### name\_it\_t Type of an iterator over this B+Tree. +##### name\_type\_t + +Type of one item in the B+Tree. It is either: + +* a structure composed of a pointer to the key (field key_ptr) and a pointer to the value (field value_ptr) if the B+Tree is a map +* or the basic type of the container if the B+Tree is a set. + ##### void name\_init(name\_t tree) Initialize the B+Tree 'tree' and set it to empty. @@ -3039,8 +3046,8 @@ Return true if both iterators reference the same object. Update the iterator 'it' to the next element. -##### type *name\_ref(name\_it_\_t it) -##### const type *name\_ref(name\_it_\_t it) +##### name\_type\_t *name\_ref(name\_it_\_t it) +##### const name\_type\_t *name\_ref(name\_it_\_t it) Return a pointer to the element pointer by the iterator 'it'. This pointer remains valid until the B+Tree is modified by another method.