/*

     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 31.08.2005

  *

  */

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

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

 /**

  * This interface may be combined with single commodity flow interfaces,

  * turning them into the equivalent multicommodity flow variant.

  * 

  * @author schickin

  *

  */

 public interface MulticommodityCapable {

     /**

      * Define the number of commodities. Must be called before any call

      * to focusOnCommodity. Default is one.

      * 

      * @param numCommodities

      */

     public void setNumCommodities(int numCommodities);

     /**

      * All subsequent calls for a single commodity (e.g. setting the edge

      * weight, the inflow or the individual capacitiy) refer to the given

      * commodity.

      * 

      * @param numCommodity the commodity to which all subsequent calls

      * shall refer.

      */

     public void focusOnCommodity(int numCommodity);

     /**

      * Set the edge capacities for the sum of the flows.

      * 

      * @param edgeCapacities a map containing the edge capacities.

      */

     public void setCommonEdgeCapacityMap(FixedDoubleEdgeMap edgeCapacities);

 }