function lfds711_btree_au_get_by_relative_position

From liblfds.org
Jump to navigation Jump to search

Source Files

└───liblfds711
    ├───inc
    │   └───liblfds711
    │           lfds711_btree_addonly_unbalanced.h
    └───src
        └───lfds711_btree_addonly_unbalanced
                lfds711_btree_addonly_unbalanced_get.c

Opaque Structures

struct lfds711_btree_au_element;
struct lfds711_btree_au_state;

Enums

enum lfds711_btree_au_relative_position
{
  LFDS711_BTREE_AU_RELATIVE_POSITION_UP,
  LFDS711_BTREE_AU_RELATIVE_POSITION_LEFT,
  LFDS711_BTREE_AU_RELATIVE_POSITION_RIGHT,
  LFDS711_BTREE_AU_RELATIVE_POSITION_SMALLEST_ELEMENT_BELOW_CURRENT_ELEMENT,
  LFDS711_BTREE_AU_RELATIVE_POSITION_LARGEST_ELEMENT_BELOW_CURRENT_ELEMENT,
  LFDS711_BTREE_AU_RELATIVE_POSITION_NEXT_SMALLER_ELEMENT_IN_ENTIRE_TREE,
  LFDS711_BTREE_AU_RELATIVE_POSITION_NEXT_LARGER_ELEMENT_IN_ENTIRE_TREE
};

Prototype

int lfds711_btree_au_get_by_relative_position( struct lfds711_btree_au_element **baue,
                                               enum lfds711_btree_au_relative_position relative_position );

Parameters

struct lfds711_btree_au_element **baue

This argument is the address of a pointer to an element in a btree. Typically this pointer is initially obtained by calling lfds711_btree_au_get_by_absolute_position. This argument is then set to point to the element retrieved by the function, according to the direction argument.

enum lfds711_btree_au_relative_position relative_position

Indicates which element *baue should be moved to, using the original element pointed to by *baue as the starting point.

Return Value

Returns 1 if a btree element was found in the given direction, 0 otherwise.

Notes

No notes.

See Also