WeightedDigraph.java

/*
 * Copyright 2012 Odysseus Software GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.odysseus.ithaka.digraph;

import java.util.Set;

/**
 * Weighted digraph interface.
 *
 * @param <V> edge type.
 */
public interface WeightedDigraph<V> extends Digraph<V, Integer>, EdgeWeights<V> {
	/**
	 * Adds the given weight to the edge specified by its source and target vertices.
	 * Automatically inserts the edge if necessary.
	 * @param source source vertex
	 * @param target target vertex
	 * @param weight weight to be added
	 */
	public void add(V source, V target, int weight);

	/**
	 * @return sum of edge weights
	 */
	public int totalWeight();
	
	/**
	 * Restrict result type.
	 */
	@Override
	public WeightedDigraph<V> reverse();
	
	/**
	 * Restrict result type.
	 */
	@Override
	public WeightedDigraph<V> subgraph(Set<V> vertices);
}