Author: marcosperanza
Date: Thu Jul 12 15:21:57 2012
New Revision: 1360721
URL: http://svn.apache.org/viewvc?rev=1360721&view=rev
Log:
Filled some javadocs, no functional modifications
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
Thu Jul 12 15:21:57 2012
@@ -54,6 +54,7 @@ public abstract class AbstractGraphConne
/**
* Adds a new vertex to graph connector.
*
+ * @param <N> the Graph vertex type
* @param node the vertex to add
* @return the vertex added
*/
@@ -65,6 +66,7 @@ public abstract class AbstractGraphConne
/**
* Adds a new edge to graph connector.
*
+ * @param <A> the Graph edges type
* @param arc the edge to add.
* @return the {@link HeadVertexConnector}
*/
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
Thu Jul 12 15:21:57 2012
@@ -31,6 +31,7 @@ public interface GraphConnector<V, E>
/**
* Adds a new vertex to graph.
*
+ * @param <N> the Graph vertices type
* @param node the vertex to add
* @return the vertex added
*/
@@ -39,6 +40,7 @@ public interface GraphConnector<V, E>
/**
* Adds a new edge to graph.
*
+ * @param <A> the Graph edges type
* @param arc the edge to add.
* @return the {@link HeadVertexConnector}
*/
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
Thu Jul 12 15:21:57 2012
@@ -32,6 +32,7 @@ public interface HeadVertexConnector<V,
/**
* Specifies the head vertex for the edge
*
+ * @param <H> the Graph vertex type
* @param head the head vertex
* @return {@link TailVertexConnector} builded from the head
*/
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
Thu Jul 12 15:21:57 2012
@@ -30,6 +30,8 @@ public interface TailVertexConnector<V,
/**
* Specifies the tail vertex for the edge
+ *
+ * @param <T> the Graph vertex type
* @param tail the tail vertex
*/
<T extends V> void to( T tail );
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/collections/DisjointSet.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/collections/DisjointSet.java
Thu Jul 12 15:21:57 2012
@@ -39,7 +39,7 @@ public final class DisjointSet<E>
* Performs the {@code find} operation applying the <i>path
compression</i>.
*
* @param e the element has to be find in this {@code DisjointSet} instance
- * @return
+ * @return the value found
*/
public E find( E e )
{
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/DefaultColorsBuilder.java
Thu Jul 12 15:21:57 2012
@@ -37,6 +37,10 @@ public final class DefaultColorsBuilder<
private final UndirectedGraph<V, E> graph;
+ /**
+ * Creates a new instance of {@link DefaultColorsBuilder} for the input
graph.
+ * @param graph the graph
+ */
public DefaultColorsBuilder( UndirectedGraph<V, E> graph )
{
this.graph = graph;
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/coloring/NotEnoughColorsException.java
Thu Jul 12 15:21:57 2012
@@ -25,12 +25,21 @@ import java.util.Set;
import org.apache.commons.graph.GraphException;
+/**
+ * Exception used by Coloring algorithms. Used when there are not enough
colors to
+ * color the graph.
+ *
+ */
public class NotEnoughColorsException
extends GraphException
{
private static final long serialVersionUID = -8782950517745777605L;
+ /**
+ * Creates new instance of {@link NotEnoughColorsException}.
+ * @param colors the set of color.
+ */
public NotEnoughColorsException( Set<?> colors )
{
super( format( "Input color set %s has not enough colors to color the
given graph", colors ) );
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityAlgorithmsSelector.java
Thu Jul 12 15:21:57 2012
@@ -30,6 +30,8 @@ import java.util.List;
import org.apache.commons.graph.Graph;
/**
+ * TODO Fill me!!
+ *
* @param <V> the Graph vertices type
* @param <E> the Graph edges type
*/
@@ -41,6 +43,12 @@ final class DefaultConnectivityAlgorithm
private final Iterable<V> includedVertices;
+ /**
+ * Create a new instance of {@link DefaultConnectivityAlgorithmsSelector}
calculated for a set of included vertices
+ *
+ * @param graph the graph
+ * @param includedVertices included vertices
+ */
public DefaultConnectivityAlgorithmsSelector( Graph<V, E> graph,
Iterable<V> includedVertices )
{
this.graph = graph;
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/connectivity/DefaultConnectivityBuilder.java
Thu Jul 12 15:21:57 2012
@@ -25,6 +25,8 @@ import static org.apache.commons.graph.u
import org.apache.commons.graph.Graph;
/**
+ * TODO Fill me!!
+ *
* @param <V> the Graph vertices type
* @param <E> the Graph edges type
*/
@@ -34,6 +36,10 @@ public class DefaultConnectivityBuilder<
private final Graph<V, E> graph;
+ /**
+ * Creates a nw instance of {@link DefaultConnectivityBuilder}
+ * @param graph the graph
+ */
public DefaultConnectivityBuilder( Graph<V, E> graph )
{
this.graph = graph;
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/DefaultRankingSelector.java
Thu Jul 12 15:21:57 2012
@@ -23,17 +23,29 @@ import static org.apache.commons.graph.u
import org.apache.commons.graph.DirectedGraph;
+/**
+ * TODO Fill me!!
+ *
+ * @param <P> The player's type
+ */
public final class DefaultRankingSelector<P>
implements RankingSelector<P>
{
private final DirectedGraph<P, GameResult> tournamentGraph;
+ /**
+ * Creates a new instance of {@link DefaultRankingSelector} for gived
graph.
+ * @param tournamentGraph the graph
+ */
public DefaultRankingSelector( DirectedGraph<P, GameResult>
tournamentGraph )
{
this.tournamentGraph = tournamentGraph;
}
+ /**
+ * {@inheritDoc}
+ */
public KFactorBuilder<P> werePlayersArRankedIn( PlayersRank<P> playersRank
)
{
playersRank = checkNotNull( playersRank, "ELO ranking can not be
applied if players can not be ranked!" );
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/PlayersRank.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/PlayersRank.java
Thu Jul 12 15:21:57 2012
@@ -19,11 +19,26 @@ package org.apache.commons.graph.elo;
* under the License.
*/
+/**
+ * The player rank
+ *
+ * @param <P> the player's type
+ */
public interface PlayersRank<P>
{
+ /**
+ * Returns the ranking for the player
+ * @param player the player
+ * @return Returns the ranking for the player
+ */
Double getRanking( P player );
+ /**
+ * Update the ranking for the player
+ * @param player the player
+ * @param ranking the ranking value
+ */
void updateRanking( P player, Double ranking );
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/RankingSelector.java?rev=1360721&r1=1360720&r2=1360721&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/RankingSelector.java
Thu Jul 12 15:21:57 2012
@@ -19,9 +19,19 @@ package org.apache.commons.graph.elo;
* under the License.
*/
+/**
+ * Ranking selector
+ * @param <P> the player's type
+ */
public interface RankingSelector<P>
{
+ /**
+ * TODO Fill me!!!
+ *
+ * @param playersRank
+ * @return
+ */
KFactorBuilder<P> werePlayersArRankedIn( PlayersRank<P> playersRank );
}
