source/blender/blenlib/BLI_edgehash.h

   1 /**
   2  * A general unordered 2-int pair hash table ADT
   3  *
   4  * $Id: BLI_edgehash.h 5183 2005-08-23 02:29:22Z zuster $
   5  *
   6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version. The Blender
  12  * Foundation also sells licenses for use in proprietary software under
  13  * the Blender License.  See http://www.blender.org/BL/ for information
  14  * about this.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software Foundation,
  23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  *
  25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  26  * All rights reserved.
  27  *
  28  * The Original Code is: none of this file.
  29  *
  30  * Contributor(s): Daniel Dunbar
  31  *
  32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  33  */
  34
  35 #ifndef BLI_EDGEHASH_H
  36 #define BLI_EDGEHASH_H
  37
  38 struct EdgeHash;
  39 struct EdgeHashIterator;
  40 typedef struct EdgeHash EdgeHash;
  41 typedef struct EdgeHashIterator EdgeHashIterator;
  42
  43 typedef void    (*EdgeHashFreeFP)(void *key);
  44
  45 EdgeHash*               BLI_edgehash_new                (void);
  46 void                    BLI_edgehash_free               (EdgeHash *eh, EdgeHashFreeFP valfreefp);
  47
  48         /* Insert edge (v0,v1) into hash with given value, does
  49          * not check for duplicates.
  50          */
  51 void                    BLI_edgehash_insert             (EdgeHash *eh, int v0, int v1, void *val);
  52
  53         /* Return value for given edge (v0,v1), or NULL if
  54          * if key does not exist in hash. (If need exists
  55          * to differentiate between key-value being NULL and
  56          * lack of key then see BLI_edgehash_lookup_p().
  57          */
  58 void*                   BLI_edgehash_lookup             (EdgeHash *eh, int v0, int v1);
  59
  60         /* Return pointer to value for given edge (v0,v1),
  61          * or NULL if key does not exist in hash.
  62          */
  63 void**                  BLI_edgehash_lookup_p   (EdgeHash *eh, int v0, int v1);
  64
  65         /* Return boolean true/false if edge (v0,v1) in hash. */
  66 int                             BLI_edgehash_haskey             (EdgeHash *eh, int v0, int v1);
  67
  68         /* Return number of keys in hash. */
  69 int                             BLI_edgehash_size               (EdgeHash *eh);
  70
  71         /* Remove all edges from hash. */
  72 void                    BLI_edgehash_clear              (EdgeHash *eh, EdgeHashFreeFP valfreefp);
  73
  74 /***/
  75
  76         /**
  77          * Create a new EdgeHashIterator. The hash table must not be mutated
  78          * while the iterator is in use, and the iterator will step exactly
  79          * BLI_edgehash_size(gh) times before becoming done.
  80          */
  81 EdgeHashIterator*       BLI_edgehashIterator_new                (EdgeHash *eh);
  82
  83         /* Free an EdgeHashIterator. */
  84 void                            BLI_edgehashIterator_free               (EdgeHashIterator *ehi);
  85
  86         /* Retrieve the key from an iterator. */
  87 void                            BLI_edgehashIterator_getKey             (EdgeHashIterator *ehi, int *v0_r, int *v1_r);
  88
  89         /* Retrieve the value from an iterator. */
  90 void*                           BLI_edgehashIterator_getValue   (EdgeHashIterator *ehi);
  91
  92         /* Steps the iterator to the next index. */
  93 void                            BLI_edgehashIterator_step               (EdgeHashIterator *ehi);
  94
  95         /* Determine if an iterator is done. */
  96 int                                     BLI_edgehashIterator_isDone             (EdgeHashIterator *ehi);
  97
  98 #endif
  99