hungarian.h

/********************************************************************
 ********************************************************************
 **
 ** libhungarian by Cyrill Stachniss, 2004
 **
 ** Added to libFirm by Christian Wuerdig, 2006
 ** Added several options for not-perfect matchings.
 **
 ** Solving the Minimum Assignment Problem using the
 ** Hungarian Method.
 **
 ** ** This file may be freely copied and distributed! **
 **
 ** Parts of the used code was originally provided by the
 ** "Stanford GraphGase", but I made changes to this code.
 ** As asked by  the copyright node of the "Stanford GraphGase",
 ** I hereby proclaim that this file are *NOT* part of the
 ** "Stanford GraphGase" distribution!
 **
 ** This file is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied
 ** warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 ** PURPOSE.
 **
 ********************************************************************
 ********************************************************************/

#ifndef FIRM_ADT_HUNGARIAN_H
#define FIRM_ADT_HUNGARIAN_H

#include "../begin.h"

typedef enum match_type_t {
    HUNGARIAN_MATCH_NORMAL,   
    HUNGARIAN_MATCH_PERFECT   
} match_type_t;

typedef enum hungarian_mode_t {
    HUNGARIAN_MODE_MINIMIZE_COST, 
    HUNGARIAN_MODE_MAXIMIZE_UTIL  
} hungarian_mode_t;

typedef struct hungarian_problem_t hungarian_problem_t;

FIRM_API hungarian_problem_t *hungarian_new(unsigned num_rows,
                                            unsigned num_cols,
                                            match_type_t match_type);

FIRM_API void hungarian_add(hungarian_problem_t *p, unsigned left,
                            unsigned right, unsigned cost);

FIRM_API void hungarian_remove(hungarian_problem_t *p, unsigned left,
                               unsigned right);

FIRM_API void hungarian_prepare_cost_matrix(hungarian_problem_t *p,
                                            hungarian_mode_t mode);

FIRM_API void hungarian_free(hungarian_problem_t *p);

FIRM_API int hungarian_solve(hungarian_problem_t *p, unsigned *assignment,
                             unsigned *final_cost, unsigned cost_threshold);

FIRM_API void hungarian_print_cost_matrix(hungarian_problem_t const *p,
                                          int cost_width);

#include "../end.h"

#endif