@note instead of @Note
[libfirm] / 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 typedef struct _bipartite_t bipartite_t;
30
31 bipartite_t *bipartite_new(int n_left, int n_right);
32 void bipartite_free(bipartite_t *gr);
33 void bipartite_add(bipartite_t *gr, int i, int j);
34 void bipartite_remv(bipartite_t *gr, int i, int j);
35 int bipartite_adj(const bipartite_t *gr, int i, int j);
36 void bipartite_matching(const bipartite_t *gr, int *matching);
37
38 /**
39  * Dumps a bipartite graph to a file stream.
40  */
41 void bipartite_dump_f(FILE *f, const bipartite_t *gr);
42
43 /**
44  * Dumps a bipartite graph to file name.
45  */
46 void bipartite_dump(const char *name, const bipartite_t *gr);
47
48 #endif /* _BIPARTITE_H */