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 #include "../begin.h"
  37
  38 typedef enum match_type_t {
  39         HUNGARIAN_MATCH_NORMAL,   /**< ever nodes matches another node */
  40         HUNGARIAN_MATCH_PERFECT   /**< matchings of nodes having no edge getting
  41                                        removed */
  42 } match_type_t;
  43
  44 typedef enum hungarian_mode_t {
  45         HUNGARIAN_MODE_MINIMIZE_COST,
  46         HUNGARIAN_MODE_MAXIMIZE_UTIL
  47 } hungarian_mode_t;
  48
  49 typedef struct hungarian_problem_t hungarian_problem_t;
  50
  51 /**
  52  * This method initialize the hungarian_problem structure and init
  53  * the cost matrix (missing lines or columns are filled with 0).
  54  *
  55  * @param num_rows   Number of rows in the given matrix
  56  * @param num_cols   Number of cols in the given matrix
  57  * @param match_type The type of matching
  58  * @return The problem object.
  59  */
  60 FIRM_API hungarian_problem_t *hungarian_new(unsigned num_rows,
  61                                             unsigned num_cols,
  62                                             match_type_t match_type);
  63
  64 /**
  65  * Adds an edge from left to right with some costs.
  66  */
  67 FIRM_API void hungarian_add(hungarian_problem_t *p, unsigned left,
  68                             unsigned right, unsigned cost);
  69
  70 /**
  71  * Removes the edge from left to right.
  72  */
  73 FIRM_API void hungarian_remove(hungarian_problem_t *p, unsigned left,
  74                                unsigned right);
  75
  76 /**
  77  * Prepares the cost matrix dependent on the given mode.
  78  *
  79  * @param p     The hungarian object
  80  * @param mode  specify whether to minimize or maximize the costs
  81  */
  82 FIRM_API void hungarian_prepare_cost_matrix(hungarian_problem_t *p,
  83                                             hungarian_mode_t mode);
  84
  85 /**
  86  * Destroys the hungarian object.
  87  */
  88 FIRM_API void hungarian_free(hungarian_problem_t *p);
  89
  90 /**
  91  * This method computes the optimal assignment.
  92  * @param p              The hungarian object
  93  * @param assignment     The final assignment
  94  * @param final_cost     The final costs
  95  * @param cost_threshold Matchings with costs >= this limit will be removed (if limit > 0)
  96  * @return 0 on success, negative number otherwise
  97  */
  98 FIRM_API int hungarian_solve(hungarian_problem_t *p, unsigned *assignment,
  99                              unsigned *final_cost, unsigned cost_threshold);
 100
 101 /**
 102  * Print the cost matrix.
 103  * @param p          The hungarian object
 104  * @param cost_width The minimum field width of the costs
 105  */
 106 FIRM_API void hungarian_print_cost_matrix(hungarian_problem_t *p,
 107                                           int cost_width);
 108
 109 #include "../end.h"
 110
 111 #endif