| 1 | /* $Id: avl_Enum.cpp.h 8155 2008-04-18 15:16:47Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * Enumeration routines for AVL trees.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | *
|
|---|
| 26 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 27 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 28 | * additional information or have any questions.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | #ifndef _kAVLEnum_h_
|
|---|
| 32 | #define _kAVLEnum_h_
|
|---|
| 33 |
|
|---|
| 34 |
|
|---|
| 35 | /**
|
|---|
| 36 | * Gets the root node.
|
|---|
| 37 | *
|
|---|
| 38 | * @returns Pointer to the root node.
|
|---|
| 39 | * @returns NULL if the tree is empty.
|
|---|
| 40 | *
|
|---|
| 41 | * @param ppTree Pointer to pointer to the tree root node.
|
|---|
| 42 | */
|
|---|
| 43 | RTDECL(PKAVLNODECORE) KAVL_FN(GetRoot)(PPKAVLNODECORE ppTree)
|
|---|
| 44 | {
|
|---|
| 45 | return KAVL_GET_POINTER_NULL(ppTree);
|
|---|
| 46 | }
|
|---|
| 47 |
|
|---|
| 48 |
|
|---|
| 49 | /**
|
|---|
| 50 | * Gets the right node.
|
|---|
| 51 | *
|
|---|
| 52 | * @returns Pointer to the right node.
|
|---|
| 53 | * @returns NULL if no right node.
|
|---|
| 54 | *
|
|---|
| 55 | * @param pNode The current node.
|
|---|
| 56 | */
|
|---|
| 57 | RTDECL(PKAVLNODECORE) KAVL_FN(GetRight)(PKAVLNODECORE pNode)
|
|---|
| 58 | {
|
|---|
| 59 | if (pNode)
|
|---|
| 60 | return KAVL_GET_POINTER_NULL(&pNode->pRight);
|
|---|
| 61 | return NULL;
|
|---|
| 62 | }
|
|---|
| 63 |
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * Gets the left node.
|
|---|
| 67 | *
|
|---|
| 68 | * @returns Pointer to the left node.
|
|---|
| 69 | * @returns NULL if no left node.
|
|---|
| 70 | *
|
|---|
| 71 | * @param pNode The current node.
|
|---|
| 72 | */
|
|---|
| 73 | RTDECL(PKAVLNODECORE) KAVL_FN(GetLeft)(PKAVLNODECORE pNode)
|
|---|
| 74 | {
|
|---|
| 75 | if (pNode)
|
|---|
| 76 | return KAVL_GET_POINTER_NULL(&pNode->pLeft);
|
|---|
| 77 | return NULL;
|
|---|
| 78 | }
|
|---|
| 79 |
|
|---|
| 80 |
|
|---|
| 81 | # ifdef KAVL_EQUAL_ALLOWED
|
|---|
| 82 | /**
|
|---|
| 83 | * Gets the next node with an equal (start) key.
|
|---|
| 84 | *
|
|---|
| 85 | * @returns Pointer to the next equal node.
|
|---|
| 86 | * @returns NULL if the current node was the last one with this key.
|
|---|
| 87 | *
|
|---|
| 88 | * @param pNode The current node.
|
|---|
| 89 | */
|
|---|
| 90 | RTDECL(PKAVLNODECORE) KAVL_FN(GetNextEqual)(PKAVLNODECORE pNode)
|
|---|
| 91 | {
|
|---|
| 92 | if (pNode)
|
|---|
| 93 | return KAVL_GET_POINTER_NULL(&pNode->pList);
|
|---|
| 94 | return NULL;
|
|---|
| 95 | }
|
|---|
| 96 | # endif /* KAVL_EQUAL_ALLOWED */
|
|---|
| 97 |
|
|---|
| 98 | #endif
|
|---|
| 99 |
|
|---|
