Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
FeasibleFlowAlg |
|
| 1.0;1 |
1 | /* | |
2 | This file is part of Combean. | |
3 | ||
4 | Combean is free software; you can redistribute it and/or modify | |
5 | it under the terms of the GNU General Public License as published by | |
6 | the Free Software Foundation; either version 2 of the License, or | |
7 | (at your option) any later version. | |
8 | ||
9 | Combean is distributed in the hope that it will be useful, | |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | GNU General Public License for more details. | |
13 | ||
14 | You should have received a copy of the GNU General Public License | |
15 | along with Combean; if not, write to the Free Software | |
16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
17 | */ | |
18 | /* | |
19 | * Created on 30.08.2005 | |
20 | * | |
21 | */ | |
22 | package net.sourceforge.combean.interfaces.graph.alg.flow; | |
23 | ||
24 | import net.sourceforge.combean.interfaces.graph.containers.doubleval.FixedDoubleNodeMap; | |
25 | ||
26 | /** | |
27 | * A flow algorithm for finding a feasible flow with given flow balance | |
28 | * for each node (if one exists). | |
29 | * | |
30 | * @author schickin | |
31 | * | |
32 | */ | |
33 | public interface FeasibleFlowAlg extends AbstractFlowAlg { | |
34 | ||
35 | /** | |
36 | * Set the inflow at each node in the graph. | |
37 | * A positive value means that additional flow is injected at the node, | |
38 | * whereas a negative value represents the fact that flow is drained | |
39 | * from the network. If this map is not set, the flow balance at each | |
40 | * node is assumed to be zero, i.e., inbound equals outbound flow. | |
41 | * | |
42 | * @param inflowMap the inflow at each node. | |
43 | */ | |
44 | public void setInflowMap(FixedDoubleNodeMap inflowMap); | |
45 | ||
46 | /** | |
47 | * Check if a feasible flow exists. May only be called after the | |
48 | * algorithm has been executed. | |
49 | * | |
50 | * @return true if a feasible flow exists. | |
51 | */ | |
52 | boolean isFeasible(); | |
53 | } |