/*

     This file is part of Combean.

     Combean is free software; you can redistribute it and/or modify

     it under the terms of the GNU General Public License as published by

     the Free Software Foundation; either version 2 of the License, or

     (at your option) any later version.

     Combean 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.  See the

     GNU General Public License for more details.

     You should have received a copy of the GNU General Public License

     along with Combean; if not, write to the Free Software

     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

 */

 /*

  * Created on 30.08.2005

  *

  */

 package net.sourceforge.combean.interfaces.graph.alg.flow;

 import net.sourceforge.combean.interfaces.graph.containers.doubleval.FixedDoubleEdgeMap;

 /**

  * A min-cost flow algorithm (with positive flows in the range 0 ... capacity).

  * 

  * @author schickin

  *

  */

 public interface MinCostFlowAlg extends FeasibleFlowAlg {

     /**

      * Set the cost of one unit of flow for each edge. If this map is not

      * set, the cost is assumed to be zero for each edge.

      * 

      * @param edgeWeights a map containing the cost of each edge in the graph

      */

     public void setEdgeWeightsMap(FixedDoubleEdgeMap edgeWeights);

     /**

      * Calculate the total cost of the flow. May only be called after the

      * algorithm has been executed.

      * 

      * @return the total cost of the flow.

      */

     double getTotalCost();

 }