commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From marcospera...@apache.org
Subject svn commit: r1361090 - in /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph: export/ flow/
Date Fri, 13 Jul 2012 08:31:51 GMT
Author: marcosperanza
Date: Fri Jul 13 08:31:51 2012
New Revision: 1361090

URL: http://svn.apache.org/viewvc?rev=1361090&view=rev
Log:
Filled some javadocs, no functional modifications

Modified:
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
Fri Jul 13 08:31:51 2012
@@ -24,8 +24,8 @@ import static org.apache.commons.graph.u
 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 @@ public final class DefaultExportSelector
     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 )

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFlowWeightedEdgesBuilder.java
Fri Jul 13 08:31:51 2012
@@ -24,17 +24,30 @@ import static org.apache.commons.graph.u
 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." );

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultFromHeadBuilder.java
Fri Jul 13 08:31:51 2012
@@ -27,10 +27,10 @@ import org.apache.commons.graph.Mapper;
 /**
  * {@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>

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultMaxFlowAlgorithmSelector.java
Fri Jul 13 08:31:51 2012
@@ -32,10 +32,9 @@ import org.apache.commons.graph.weight.O
 /**
  * {@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>

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/DefaultToTailBuilder.java
Fri Jul 13 08:31:51 2012
@@ -27,9 +27,9 @@ import org.apache.commons.graph.Mapper;
 /**
  * {@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>

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/FromHeadBuilder.java
Fri Jul 13 08:31:51 2012
@@ -19,12 +19,18 @@ package org.apache.commons.graph.flow;
  * 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
      */

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/MaxFlowAlgorithmSelector.java
Fri Jul 13 08:31:51 2012
@@ -21,6 +21,13 @@ package org.apache.commons.graph.flow;
 
 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 @@ public interface MaxFlowAlgorithmSelecto
      *
      * @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 @@ public interface MaxFlowAlgorithmSelecto
      *
      * @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
);
 

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java?rev=1361090&r1=1361089&r2=1361090&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/flow/ToTailBuilder.java
Fri Jul 13 08:31:51 2012
@@ -19,12 +19,19 @@ package org.apache.commons.graph.flow;
  * 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
      */



Mime
View raw message