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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/adt/unionfind.h
   4  * Purpose:     Union-Find datastructure
   5  * Author:      Matthias Braun
   6  * Modified by:
   7  * CVS-ID:      $Id$
   8  * Copyright:   (c) 2006, Matthias Braun
   9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  10  */
  11
  12 /**
  13  * @file unionfind.h
  14  *
  15  * Union-Find datastructure
  16  *
  17  * This implementation uses weighted sets and path compression which results
  18  * in O(n) complexity for n find and union operations (actually it's
  19  * n * alpha(n) with alpha being the inverse of the ackermann function and
  20  * therefore smaller than 5 for all 64bit values of n)
  21  */
  22 #ifndef _UNIONFIND_H
  23 #define _UNIONFIND_H
  24
  25 #include <assert.h>
  26
  27 /**
  28  * Call this to initialize an array of @p count elements to be used by the
  29  * union find functions.
  30  *
  31  * @param data  The array (you have to allocate it yourself)
  32  * @param from  The first element that should be intialized
  33  * @param to    the index of the first element which is not initialized anymore
  34  */
  35 static INLINE void uf_init(int* data, int from, int to)
  36 {
  37         int i;
  38         for(i = from; i < to; ++i) {
  39                 data[i] = -1;
  40         }
  41 }
  42
  43 /**
  44  * Merge 2 sets (union operation). Note that you have to pass the
  45  * representatives of the sets and not just random elements
  46  *
  47  * @param data  The union find data
  48  * @param set1  Representative of set1
  49  * @param set2  Representative of set2
  50  * @return              0 if the new union set is represented by set1, 1 if it is
  51  *              represented by set2
  52  */
  53 static INLINE int uf_union(int* data, int set1, int set2) {
  54         int d1 = data[set1];
  55         int d2 = data[set2];
  56         int newcount;
  57
  58         if(set1 == set2)
  59                 return 0;
  60
  61         // need 2 set representatives
  62         assert(d1 < 0 && d2 < 0);
  63
  64         newcount = d1 + d2;
  65         if(d1 > d2) {
  66                 data[set1] = set2;
  67                 data[set2] = newcount;
  68                 return 1;
  69         } else {
  70                 data[set2] = set1;
  71                 data[set1] = newcount;
  72                 return 0;
  73         }
  74 }
  75
  76 /**
  77  * Finds the representative for the set with member @p e.
  78  * The representative of a set is unique, so if the find operations finds
  79  * the same/different representatives, then the elements are in the
  80  * the same/different sets.
  81  *
  82  * @param data  The union find data
  83  * @param e             The element
  84  * @return              The representative of the set that contains @p e
  85  */
  86 static INLINE int uf_find(int* data, int e) {
  87         // go through list to find representative
  88     int repr = e;
  89         while(data[repr] >= 0) {
  90                 repr = data[repr];
  91         }
  92
  93         // update list to point to new representative (path compression)
  94         while(e != repr) {
  95                 int next = data[e];
  96                 data[e] = repr;
  97                 e = next;
  98         }
  99
 100         return repr;
 101 }
 102
 103 #endif