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

   1 /********************************************************************
   2  ********************************************************************
   3  **
   4  ** libhungarian by Cyrill Stachniss, 2004
   5  **
   6  ** Added to libFirm by Christian Wuerdig, 2006
   7  ** Added several options for not-perfect matchings.
   8  **
   9  ** Solving the Minimum Assignment Problem using the
  10  ** Hungarian Method.
  11  **
  12  ** ** This file may be freely copied and distributed! **
  13  **
  14  ** Parts of the used code was originally provided by the
  15  ** "Stanford GraphGase", but I made changes to this code.
  16  ** As asked by  the copyright node of the "Stanford GraphGase",
  17  ** I hereby proclaim that this file are *NOT* part of the
  18  ** "Stanford GraphGase" distribution!
  19  **
  20  ** This file is distributed in the hope that it will be useful,
  21  ** but WITHOUT ANY WARRANTY; without even the implied
  22  ** warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  23  ** PURPOSE.
  24  **
  25  ********************************************************************
  26  ********************************************************************/
  27
  28 /**
  29  * @file
  30  * @brief   Solving the Minimum Assignment Problem using the Hungarian Method.
  31  * @version $Id$
  32  */
  33 #ifndef FIRM_ADT_HUNGARIAN_H
  34 #define FIRM_ADT_HUNGARIAN_H
  35
  36 #define HUNGARIAN_MODE_MINIMIZE_COST 0
  37 #define HUNGARIAN_MODE_MAXIMIZE_UTIL 1
  38
  39 #define HUNGARIAN_MATCH_NORMAL  0
  40 #define HUNGARIAN_MATCH_PERFECT 1
  41
  42 typedef struct _hungarian_problem_t hungarian_problem_t;
  43
  44 /**
  45  * This method initialize the hungarian_problem structure and init
  46  * the cost matrix (missing lines or columns are filled with 0).
  47  *
  48  * @param rows       Number of rows in the given matrix
  49  * @param cols       Number of cols in the given matrix
  50  * @param match_type The type of matching:
  51  *                   HUNGARIAN_MATCH_PERFECT - every nodes matches another node
  52  *                   HUNGARIAN_MATCH_NORMAL  - matchings of nodes having no edge getting removed
  53  * @return The problem object.
  54  */
  55 hungarian_problem_t *hungarian_new(int rows, int cols, int match_type);
  56
  57 /**
  58  * Adds an edge from left to right with some costs.
  59  */
  60 void hungarian_add(hungarian_problem_t *p, int left, int right, int cost);
  61
  62 /**
  63 * Removes the edge from left to right.
  64 */
  65 void hungarian_remv(hungarian_problem_t *p, int left, int right);
  66
  67 /**
  68  * Prepares the cost matrix dependent on the given mode.
  69  *
  70  * @param p     The hungarian object
  71  * @param mode  HUNGARIAN_MODE_MAXIMIZE_UTIL or HUNGARIAN_MODE_MINIMIZE_COST (default)
  72  */
  73 void hungarian_prepare_cost_matrix(hungarian_problem_t *p, int mode);
  74
  75 /**
  76  * Destroys the hungarian object.
  77  */
  78 void hungarian_free(hungarian_problem_t *p);
  79
  80 /**
  81  * This method computes the optimal assignment.
  82  * @param p              The hungarian object
  83  * @param assignment     The final assignment
  84  * @param final_cost     The final costs
  85  * @param cost_threshold Matchings with costs >= this limit will be removed (if limit > 0)
  86  * @return 0 on success, negative number otherwise
  87  */
  88 int hungarian_solve(hungarian_problem_t *p, int *assignment, int *final_cost, int cost_threshold);
  89
  90 /**
  91  * Print the cost matrix.
  92  * @param p          The hungarian object
  93  * @param cost_width The minimum field width of the costs
  94  */
  95 void hungarian_print_cost_matrix(hungarian_problem_t *p, int cost_width);
  96
  97 #endif /* _HUNGARIAN_H_ */