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

   1 /*
   2  * Copyright (C) 1995-2008 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  * @date   26.01.2006
  23  * @author Sebastian Hack
  24  * @brief Implements bipartite matchings.
  25  */
  26 #ifndef FIRM_ADT_BIPARTITE_H
  27 #define FIRM_ADT_BIPARTITE_H
  28
  29 #include "../begin.h"
  30
  31 /**
  32  * @ingroup algorithms
  33  * @defgroup bipartite Bipartite Matching
  34  * Solved bipartite matching problem.
  35  * (Variant with only 0/1 costs)
  36  * @{
  37  */
  38
  39 /** internal representation of bipartite matching problem */
  40 typedef struct bipartite_t bipartite_t;
  41
  42 /** Create new bipartite matching problem with @p n_left elements on left side
  43  * and @p n_right elements on right side */
  44 FIRM_API bipartite_t *bipartite_new(int n_left, int n_right);
  45 /** Free memory occupied by bipartite matching problem */
  46 FIRM_API void bipartite_free(bipartite_t *gr);
  47 /** Add edge from @p i (on the left side) to @p j (on the right side) */
  48 FIRM_API void bipartite_add(bipartite_t *gr, int i, int j);
  49 /** Remove edge from @p i (on the left side) to @p j (on the right side) */
  50 FIRM_API void bipartite_remv(bipartite_t *gr, int i, int j);
  51 /** Return 1 if edge from @p i (on the left side) to @p j (on the right side)
  52  * exists, 0 otherwise */
  53 FIRM_API int bipartite_adj(const bipartite_t *gr, int i, int j);
  54 /** Solve bipartite matching problem */
  55 FIRM_API void bipartite_matching(const bipartite_t *gr, int *matching);
  56
  57 /**
  58  * Dumps a bipartite graph to a file stream.
  59  */
  60 FIRM_API void bipartite_dump_f(FILE *f, const bipartite_t *gr);
  61
  62 /**
  63  * Dumps a bipartite graph to file name.
  64  */
  65 FIRM_API void bipartite_dump(const char *name, const bipartite_t *gr);
  66
  67 /** @} */
  68
  69 #include "../end.h"
  70
  71 #endif /* _BIPARTITE_H */