rbtree.h File Reference

Detailed Description

intrusive red black tree datastructure

Author

Robert Lion Gottwald

Definition in file rbtree.h.

#include "scip/def.h"
#include "scip/type_misc.h"

Go to the source code of this file.

Macros
#define	SCIP_RBTREE_HOOKS   SCIP_RBTREENODE _rbtreenode
#define	SCIPrbtreeFirst(root)   SCIPrbtreeFirst_call((SCIP_RBTREENODE*)(root))
#define	SCIPrbtreeLast(root)   SCIPrbtreeLast_call((SCIP_RBTREENODE*)(root))
#define	SCIPrbtreeSuccessor(x)   SCIPrbtreeSuccessor_call((SCIP_RBTREENODE*)(x))
#define	SCIPrbtreePredecessor(x)   SCIPrbtreePredecessor_call((SCIP_RBTREENODE*)(x))
#define	SCIPrbtreeDelete(root, node)   SCIPrbtreeDelete_call((SCIP_RBTREENODE**)(root), (SCIP_RBTREENODE*)(node))
#define	SCIPrbtreeInsert(r, p, c, n)   SCIPrbtreeInsert_call((SCIP_RBTREENODE**)(r), (SCIP_RBTREENODE*)(p), (c), (SCIP_RBTREENODE*)(n) )
#define	SCIPrbtreeFindInt(r, k, n)   SCIPrbtreeFindInt_call((SCIP_RBTREENODE*)(r),(k),(SCIP_RBTREENODE**)(n))
#define	SCIPrbtreeFindReal(r, k, n)   SCIPrbtreeFindReal_call((SCIP_RBTREENODE*)(r),(k),(SCIP_RBTREENODE**)(n))
#define	SCIPrbtreeFindPtr(c, r, k, n)   SCIPrbtreeFindPtr_call((c),(SCIP_RBTREENODE*)(r),(void*)(k),(SCIP_RBTREENODE**)(n))
#define	SCIPrbtreeFindElem(c, r, k, n)   SCIPrbtreeFindElem_call((c),(SCIP_RBTREENODE*)(r),(SCIP_RBTREENODE*)(k),(SCIP_RBTREENODE**)(n))
#define	FOR_EACH_NODE(type, n, r, body)
#define	SCIP_DEF_RBTREE_FIND(NAME, KEYTYPE, NODETYPE, LT, GT)

Typedefs
typedef struct SCIP_RBTreeNode	SCIP_RBTREENODE

Functions
SCIP_RBTREENODE *	SCIPrbtreeFirst_call (SCIP_RBTREENODE *root)
SCIP_RBTREENODE *	SCIPrbtreeLast_call (SCIP_RBTREENODE *root)
SCIP_RBTREENODE *	SCIPrbtreeSuccessor_call (SCIP_RBTREENODE *x)
SCIP_RBTREENODE *	SCIPrbtreePredecessor_call (SCIP_RBTREENODE *x)
void	SCIPrbtreeDelete_call (SCIP_RBTREENODE **root, SCIP_RBTREENODE *node)
void	SCIPrbtreeInsert_call (SCIP_RBTREENODE **root, SCIP_RBTREENODE *parent, int pos, SCIP_RBTREENODE *node)

Macro Definition Documentation

SCIP_RBTREE_HOOKS

#define SCIP_RBTREE_HOOKS   SCIP_RBTREENODE _rbtreenode

Definition at line 53 of file rbtree.h.

SCIPrbtreeFirst

#define SCIPrbtreeFirst

(

root

)

SCIPrbtreeFirst_call((SCIP_RBTREENODE*)(root))

Definition at line 56 of file rbtree.h.

Referenced by SCIPrbtreeDelete_call().

SCIPrbtreeLast

#define SCIPrbtreeLast

(

root

)

SCIPrbtreeLast_call((SCIP_RBTREENODE*)(root))

Definition at line 57 of file rbtree.h.

SCIPrbtreeSuccessor

#define SCIPrbtreeSuccessor

(

x

)

SCIPrbtreeSuccessor_call((SCIP_RBTREENODE*)(x))

Definition at line 58 of file rbtree.h.

SCIPrbtreePredecessor

#define SCIPrbtreePredecessor

(

x

)

SCIPrbtreePredecessor_call((SCIP_RBTREENODE*)(x))

Definition at line 59 of file rbtree.h.

SCIPrbtreeDelete

#define SCIPrbtreeDelete	(		root,
			node
	)		SCIPrbtreeDelete_call((SCIP_RBTREENODE**)(root), (SCIP_RBTREENODE*)(node))

Definition at line 60 of file rbtree.h.

Referenced by unlinkChunk().

SCIPrbtreeInsert

#define SCIPrbtreeInsert	(		r,
			p,
			c,
			n
	)		SCIPrbtreeInsert_call((SCIP_RBTREENODE**)(r), (SCIP_RBTREENODE*)(p), (c), (SCIP_RBTREENODE*)(n) )

Definition at line 61 of file rbtree.h.

Referenced by linkChunk().

SCIPrbtreeFindInt

#define SCIPrbtreeFindInt	(		r,
			k,
			n
	)		SCIPrbtreeFindInt_call((SCIP_RBTREENODE*)(r),(k),(SCIP_RBTREENODE**)(n))

Definition at line 62 of file rbtree.h.

SCIPrbtreeFindReal

#define SCIPrbtreeFindReal	(		r,
			k,
			n
	)		SCIPrbtreeFindReal_call((SCIP_RBTREENODE*)(r),(k),(SCIP_RBTREENODE**)(n))

Definition at line 63 of file rbtree.h.

SCIPrbtreeFindPtr

#define SCIPrbtreeFindPtr	(		c,
			r,
			k,
			n
	)		SCIPrbtreeFindPtr_call((c),(SCIP_RBTREENODE*)(r),(void*)(k),(SCIP_RBTREENODE**)(n))

Definition at line 64 of file rbtree.h.

SCIPrbtreeFindElem

#define SCIPrbtreeFindElem	(		c,
			r,
			k,
			n
	)		SCIPrbtreeFindElem_call((c),(SCIP_RBTREENODE*)(r),(SCIP_RBTREENODE*)(k),(SCIP_RBTREENODE**)(n))

Definition at line 65 of file rbtree.h.

FOR_EACH_NODE

#define FOR_EACH_NODE	(		type,
			n,
			r,
			body
	)

Value:

{ \
     type n; \
     type __next;  \
     n = (type) SCIPrbtreeFirst(r); \
     while( n != NULL ) \
     { \
        __next = (type) SCIPrbtreeSuccessor(n); \
        body \
        n = __next; \
     } \
   }

Definition at line 68 of file rbtree.h.

Referenced by BMScheckEmptyBlockMemory_call(), BMSdisplayBlockMemory_call(), clearChkmem(), and isPtrInChkmem().

SCIP_DEF_RBTREE_FIND

#define SCIP_DEF_RBTREE_FIND	(		NAME,
			KEYTYPE,
			NODETYPE,
			LT,
			GT
	)

Definition at line 81 of file rbtree.h.

Typedef Documentation

SCIP_RBTREENODE

typedef struct SCIP_RBTreeNode SCIP_RBTREENODE

Definition at line 33 of file rbtree.h.

Function Documentation

SCIPrbtreeFirst_call()

SCIP_RBTREENODE* SCIPrbtreeFirst_call

(

SCIP_RBTREENODE *

root

)

get first element in tree with respect to sorting key

Parameters

root	root of the tree

Definition at line 205 of file rbtree.c.

References SCIP_RBTreeNode::child, and LEFT.

Referenced by SCIPrbtreeSuccessor_call().

SCIPrbtreeLast_call()

SCIP_RBTREENODE* SCIPrbtreeLast_call

(

SCIP_RBTREENODE *

root

)

get last element in tree with respect to sorting key

Parameters

root	root of the tree

Definition at line 219 of file rbtree.c.

References SCIP_RBTreeNode::child, and RIGHT.

Referenced by SCIPrbtreePredecessor_call().

SCIPrbtreeSuccessor_call()

SCIP_RBTREENODE* SCIPrbtreeSuccessor_call

(

SCIP_RBTREENODE *

x

)

get successor of given element in the tree

Parameters

x	element to get successor for

Definition at line 233 of file rbtree.c.

References SCIP_RBTreeNode::child, PARENT, RIGHT, and SCIPrbtreeFirst_call().

SCIPrbtreePredecessor_call()

SCIP_RBTREENODE* SCIPrbtreePredecessor_call

(

SCIP_RBTREENODE *

x

)

get predecessor of given element in the tree

Parameters

x	element to get predecessor for

Definition at line 253 of file rbtree.c.

References SCIP_RBTreeNode::child, LEFT, PARENT, and SCIPrbtreeLast_call().

SCIPrbtreeDelete_call()

void SCIPrbtreeDelete_call	(	SCIP_RBTREENODE **	root,
		SCIP_RBTREENODE *	node
	)

delete the given node from the tree given by it's root node. The node must be contained in the tree rooted at root.

Parameters

root	root of the tree
node	node to delete from tree

Definition at line 275 of file rbtree.c.

References BLACK, SCIP_RBTreeNode::child, COLOR, LEFT, PARENT, SCIP_RBTreeNode::parent, rbDeleteFixup(), rbTransplant(), RIGHT, SCIPrbtreeFirst, SET_COLOR, and SET_PARENT.

SCIPrbtreeInsert_call()

void SCIPrbtreeInsert_call	(	SCIP_RBTREENODE **	root,
		SCIP_RBTREENODE *	parent,
		int	pos,
		SCIP_RBTREENODE *	node
	)

insert node into the tree given by it's root. Requires the future parent and the position of the parent as returned by the tree's find function defined using the SCIP_DEF_RBTREE_FIND macro.

Parameters

root	root of the tree
parent	future parent of node to be inserted
pos	position of parent with respect to node, i.e. -1 if the parent's key comes before node and 1 if the parent's key comes after the node
node	node to insert into the tree

Definition at line 330 of file rbtree.c.

References SCIP_RBTreeNode::child, LEFT, MAKE_RED, rbInsertFixup(), RIGHT, and SET_PARENT.