_gdsl_bintree.h

Go to the documentation of this file.

/*
 * This file is part of the Generic Data Structures Library (GDSL).
 * Copyright (C) 1998-2006 Nicolas Darnis <ndarnis@free.fr>.
 *
 * The GDSL library is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * The GDSL library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the GDSL library; see the file COPYING.
 * If not, write to the Free Software Foundation, Inc., 
 * 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 *
 * $RCSfile: _gdsl_bintree.h,v $
 * $Revision: 1.29 $
 * $Date: 2006/03/04 16:32:05 $
 */


#ifndef __GDSL_BINTREE_H_
#define __GDSL_BINTREE_H_


#include <stdio.h>


#include "gdsl_types.h"
#include "gdsl_macros.h"


#if __cplusplus
extern "C" 
{
#endif /* __cplusplus */


typedef struct _gdsl_bintree* _gdsl_bintree_t;

typedef int (* _gdsl_bintree_map_func_t) (const _gdsl_bintree_t TREE,
                      void* USER_DATA
                      );

typedef void (* _gdsl_bintree_write_func_t) (const _gdsl_bintree_t TREE,
                         FILE* OUTPUT_FILE,
                         void* USER_DATA
                         );

/******************************************************************************/
/* Management functions of low-level binary trees                             */
/******************************************************************************/

extern _gdsl_bintree_t
_gdsl_bintree_alloc (const gdsl_element_t E,
             const _gdsl_bintree_t LEFT,
             const _gdsl_bintree_t RIGHT
             );

extern void 
_gdsl_bintree_free (_gdsl_bintree_t T,
            const gdsl_free_func_t FREE_F
            );

extern _gdsl_bintree_t
_gdsl_bintree_copy (const _gdsl_bintree_t T,
            const gdsl_copy_func_t COPY_F
            );

/******************************************************************************/
/* Consultation functions of low-level binary trees                           */
/******************************************************************************/

extern bool
_gdsl_bintree_is_empty (const _gdsl_bintree_t T
            );
  
extern bool
_gdsl_bintree_is_leaf (const _gdsl_bintree_t T
               );

extern bool
_gdsl_bintree_is_root (const _gdsl_bintree_t T
               );

extern gdsl_element_t
_gdsl_bintree_get_content (const _gdsl_bintree_t T
               );

extern _gdsl_bintree_t
_gdsl_bintree_get_parent (const _gdsl_bintree_t T
              );

extern _gdsl_bintree_t
_gdsl_bintree_get_left (const _gdsl_bintree_t T
            );

extern _gdsl_bintree_t
_gdsl_bintree_get_right (const _gdsl_bintree_t T
             );

extern _gdsl_bintree_t*
_gdsl_bintree_get_left_ref (const _gdsl_bintree_t T
                );

extern _gdsl_bintree_t*
_gdsl_bintree_get_right_ref (const _gdsl_bintree_t T
                 );

extern ulong
_gdsl_bintree_get_height (const _gdsl_bintree_t T
              );

extern ulong
_gdsl_bintree_get_size (const _gdsl_bintree_t T
            );

/******************************************************************************/
/* Modification functions of low-level binary trees                           */
/******************************************************************************/

extern void
_gdsl_bintree_set_content (_gdsl_bintree_t T,
               const gdsl_element_t E
               );

extern void
_gdsl_bintree_set_parent (_gdsl_bintree_t T,
              const _gdsl_bintree_t P
              );

extern void
_gdsl_bintree_set_left (_gdsl_bintree_t T,
            const _gdsl_bintree_t L
            );
  
extern void
_gdsl_bintree_set_right (_gdsl_bintree_t T,
             const _gdsl_bintree_t R
             );

/******************************************************************************/
/* Rotation functions of low-level binary trees                               */
/******************************************************************************/

extern _gdsl_bintree_t
_gdsl_bintree_rotate_left (_gdsl_bintree_t* T
               );

extern _gdsl_bintree_t
_gdsl_bintree_rotate_right (_gdsl_bintree_t* T
                );

extern _gdsl_bintree_t
_gdsl_bintree_rotate_left_right (_gdsl_bintree_t* T
                 );

extern _gdsl_bintree_t
_gdsl_bintree_rotate_right_left (_gdsl_bintree_t* T
                 );

/******************************************************************************/
/* Parse functions of low-level binary trees                                  */
/******************************************************************************/

extern _gdsl_bintree_t
_gdsl_bintree_map_prefix (const _gdsl_bintree_t T,
              const _gdsl_bintree_map_func_t MAP_F,
              void* USER_DATA
              );

extern _gdsl_bintree_t
_gdsl_bintree_map_infix (const _gdsl_bintree_t T,
             const _gdsl_bintree_map_func_t MAP_F,
             void* USER_DATA
             );

extern _gdsl_bintree_t
_gdsl_bintree_map_postfix (const _gdsl_bintree_t T,
               const _gdsl_bintree_map_func_t MAP_F,
               void* USER_DATA
               );

/******************************************************************************/
/* Input/output functions of low-level binary trees                           */
/******************************************************************************/

extern void
_gdsl_bintree_write (const _gdsl_bintree_t T,
             const _gdsl_bintree_write_func_t WRITE_F,
             FILE* OUTPUT_FILE,
             void* USER_DATA
             );

extern void
_gdsl_bintree_write_xml (const _gdsl_bintree_t T,
             const _gdsl_bintree_write_func_t WRITE_F,
             FILE* OUTPUT_FILE,
             void* USER_DATA
             );

extern void
_gdsl_bintree_dump (const _gdsl_bintree_t T,
            const _gdsl_bintree_write_func_t WRITE_F,
            FILE* OUTPUT_FILE,
            void* USER_DATA
            );

/*
 * @}
 */


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GDSL_BINTREE_H_ */

---