nsz Git - libfirm/blob - include/libfirm/adt/unionfind.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief      Union-Find datastructure
  23  * @author     Matthias Braun
  24  * @version    $Id$
  25  * @summary
  26  *  Union-Find datastructure
  27  *
  28  *  This implementation uses weighted sets and path compression which results
  29  *  in (nearly) O(n) complexity for n find and union operations
  30  */
  31 #ifndef FIRM_ADT_UNIONFIND_H
  32 #define FIRM_ADT_UNIONFIND_H
  33
  34 #include <assert.h>
  35
  36 /**
  37  * Call this to initialize an array of @p count elements to be used by the
  38  * union find functions.
  39  *
  40  * @param data  The array (you have to allocate it yourself)
  41  * @param from  The first element that should be initialized
  42  * @param to    the index of the first element which is not initialized anymore
  43  */
  44 static INLINE void uf_init(int* data, int from, int to) {
  45         int i;
  46         for(i = from; i < to; ++i) {
  47                 data[i] = -1;
  48         }
  49 }
  50
  51 /**
  52  * Merge 2 sets (union operation). Note that you have to pass the
  53  * representatives of the sets and not just random elements
  54  *
  55  * @param data  The union find data
  56  * @param set1  Representative of set1
  57  * @param set2  Representative of set2
  58  * @return              0 if the new union set is represented by set1, 1 if it is
  59  *              represented by set2
  60  */
  61 static INLINE int uf_union(int* data, int set1, int set2) {
  62         int d1 = data[set1];
  63         int d2 = data[set2];
  64         int newcount;
  65
  66         if(set1 == set2)
  67                 return 0;
  68
  69         /* need 2 set representatives */
  70         assert(d1 < 0 && d2 < 0);
  71
  72         newcount = d1 + d2;
  73         if(d1 > d2) {
  74                 data[set1] = set2;
  75                 data[set2] = newcount;
  76                 return 1;
  77         } else {
  78                 data[set2] = set1;
  79                 data[set1] = newcount;
  80                 return 0;
  81         }
  82 }
  83
  84 /**
  85  * Finds the representative for the set with member @p e.
  86  * The representative of a set is unique, so if the find operations finds
  87  * the same/different representatives, then the elements are in the
  88  * the same/different sets.
  89  *
  90  * @param data  The union find data
  91  * @param e             The element
  92  * @return              The representative of the set that contains @p e
  93  */
  94 static INLINE int uf_find(int* data, int e) {
  95         /* go through list to find representative */
  96         int repr = e;
  97         while(data[repr] >= 0) {
  98                 repr = data[repr];
  99         }
 100
 101         /* update list to point to new representative (path compression) */
 102         while(e != repr) {
 103                 int next = data[e];
 104                 data[e] = repr;
 105                 e = next;
 106         }
 107
 108         return repr;
 109 }
 110
 111 #endif /* FIRM_ADT_UNIONFIND_H */