Skip to content
Permalink
Browse files
Filled some javadocs, no functional modifications
  • Loading branch information
marcosperanza committed Jul 13, 2012
1 parent e805dda commit c6997b0339f0b1b53ffbc30934b0f1f818cbbdaa
Showing 8 changed files with 52 additions and 20 deletions.
@@ -24,8 +24,8 @@
import org.apache.commons.graph.Graph;

/**
* TODO Fill me!!
*
* {@link NamedExportSelector} implementation
*
* @param <V> the Graph vertices type.
* @param <E> the Graph edges type.
*/
@@ -38,7 +38,7 @@
private String name = null;

/**
* Creates anew instance of export selector for the given graph
* Creates a new instance of export selector for the given graph
* @param graph the graph
*/
public DefaultExportSelector( Graph<V, E> graph )
@@ -24,17 +24,30 @@
import org.apache.commons.graph.DirectedGraph;
import org.apache.commons.graph.Mapper;

/**
* {@link FlowWeightedEdgesBuilder} implementation
*
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
*/
public final class DefaultFlowWeightedEdgesBuilder<V, WE>
implements FlowWeightedEdgesBuilder<V, WE>
{

private final DirectedGraph<V, WE> graph;

/**
* Creates a new instance of flow weighted edges builder for the given graph
* @param graph the graph
*/
public DefaultFlowWeightedEdgesBuilder( DirectedGraph<V, WE> graph )
{
this.graph = graph;
}

/**
* {@inheritDoc}
*/
public <W, M extends Mapper<WE, W>> FromHeadBuilder<V, WE, W> whereEdgesHaveWeights( M weightedEdges )
{
weightedEdges = checkNotNull( weightedEdges, "Function to calculate edges weight can not be null." );
@@ -27,10 +27,10 @@
/**
* {@link FromHeadBuilder} implementation.
*
* @param <V>
* @param <W>
* @param <WE>
* @param <G>
*
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
* @param <W> the Graph weight type
*/
final class DefaultFromHeadBuilder<V, WE, W>
implements FromHeadBuilder<V, WE, W>
@@ -32,10 +32,9 @@
/**
* {@link MaxFlowAlgorithmSelector} implementation.
*
* @param <V>
* @param <W>
* @param <WE>
* @param <G>
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
* @param <W> the Graph weight type
*/
final class DefaultMaxFlowAlgorithmSelector<V, WE, W>
implements MaxFlowAlgorithmSelector<V, WE, W>
@@ -27,9 +27,9 @@
/**
* {@link DefaultToTailBuilder} implementation.
*
* @param <V>
* @param <W>
* @param <WE>
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
* @param <W> the Graph weight type
*/
final class DefaultToTailBuilder<V, WE, W>
implements ToTailBuilder<V, WE, W>
@@ -19,12 +19,18 @@
* under the License.
*/

/**
* TODO Fill me!!!
*
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
* @param <W> the Graph weight type
*/
public interface FromHeadBuilder<V, WE, W>
{

/**
*
*
* TODO Fill me !!!
* @param head
* @return
*/
@@ -21,6 +21,13 @@

import org.apache.commons.graph.weight.OrderedMonoid;

/**
* Maximum Flow algorithm selector
*
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
* @param <W> the Graph weight type
*/
public interface MaxFlowAlgorithmSelector<V, WE, W>
{

@@ -29,7 +36,7 @@
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
* @return
* @return the max flow calculate with Ford and Furkenson algorithm
*/
<WO extends OrderedMonoid<W>> W applyingFordFulkerson( WO weightOperations );

@@ -38,7 +45,7 @@
*
* @param <WO> the type of weight operations
* @param weightOperations the class responsible for operations on weights
* @return
* @return the max flow calculate with Edmonds and Karp algorithm
*/
<WO extends OrderedMonoid<W>> W applyingEdmondsKarp( WO weightOperations );

@@ -19,12 +19,19 @@
* under the License.
*/

/**
* TODO Fill me!!!
*
* @param <V> the Graph vertices type
* @param <WE> the Graph edges type
* @param <W> the Graph weight type
*/
public interface ToTailBuilder<V, WE, W>
{

/**
*
*
* TODO Fill me!!!
*
* @param tail
* @return
*/

0 comments on commit c6997b0

Please sign in to comment.