diff --git a/R/maxflow.R b/R/maxflow.R index 3931eed..1bb9515 100644 --- a/R/maxflow.R +++ b/R/maxflow.R @@ -16,9 +16,10 @@ ##' @param algorithm Choices of algorithm include "Preflow" and "EdmondsKarp". ##' "Preflow" is the default. ##' @return A named list containing three entries: 1) "flows": a vector -##' corresponding to the flows of arcs in the graph, 2) "cut_values": a vector -##' of cut-values of the graph's nodes, and 3) "cost": the total cost of the -##' flows in the graph, i.e. the maxflow value. +##' corresponding to the flows of arcs in the graph, 2) "cut_values": 0/1 vector +##' in which 1s identify nodes belonging to a minimum-capacity cut separating the +##' source from the destination node, and 3) "cost": the total flow from source to +##' destination, i.e. the maxflow value. ##' @export MaxFlow <- function(arcSources, arcTargets, diff --git a/man/MaxFlow.Rd b/man/MaxFlow.Rd index c43a500..fc53f7c 100644 --- a/man/MaxFlow.Rd +++ b/man/MaxFlow.Rd @@ -35,9 +35,10 @@ graph's edges} } \value{ A named list containing three entries: 1) "flows": a vector - corresponding to the flows of arcs in the graph, 2) "cut_values": a vector - of cut-values of the graph's nodes, and 3) "cost": the total cost of the - flows in the graph, i.e. the maxflow value. + corresponding to the flows of arcs in the graph, 2) "cut_values": 0/1 vector + in which 1s identify nodes belonging to a minimum-capacity cut separating the + source from the destination node, and 3) "cost": the total flow from source to + destination, i.e. the maxflow value. } \description{ Finds the maximum flow of a directed graph, given a source and destination