Skip to content

Commit

Permalink
[gelly] [refactoring] Removed Example end string from all gelly examples
Browse files Browse the repository at this point in the history 
Added Algorithm end string to the library methods

This closes #625
  • Loading branch information
@andralungu @vasia
andralungu authored and vasia committed May 19, 2015
1 parent 1479973 commit 8f4039d
Show file tree
Hide file tree
Showing 28 changed files with 119 additions and 138 deletions.
28 changes: 14 additions & 14 deletions ...mple/SimpleCommunityDetectionExample.java → ...ink/graph/example/CommunityDetection.java
View file
Expand Up @@ -25,12 +25,12 @@
import org.apache.flink.graph.Edge; import org.apache.flink.graph.Edge;
import org.apache.flink.graph.Graph; import org.apache.flink.graph.Graph;
import org.apache.flink.graph.Vertex; import org.apache.flink.graph.Vertex;
import org.apache.flink.graph.example.utils.SimpleCommunityDetectionData; import org.apache.flink.graph.example.utils.CommunityDetectionData;
import org.apache.flink.graph.library.SimpleCommunityDetection; import org.apache.flink.graph.library.CommunityDetectionAlgorithm;
import org.apache.flink.graph.utils.Tuple3ToEdgeMap; import org.apache.flink.graph.utils.Tuple3ToEdgeMap;


/** /**
* This example shows how to use the {@link org.apache.flink.graph.library.SimpleCommunityDetection} * This example shows how to use the {@link org.apache.flink.graph.library.CommunityDetectionAlgorithm}
* library method: * library method:
* <ul> * <ul>
* <li> with the edge data set given as a parameter * <li> with the edge data set given as a parameter
Expand All @@ -43,12 +43,12 @@
* For example: <code>1\t2\t1.0\n1\t3\t2.0\n</code> defines two edges, * For example: <code>1\t2\t1.0\n1\t3\t2.0\n</code> defines two edges,
* 1-2 with weight 1.0 and 1-3 with weight 2.0. * 1-2 with weight 1.0 and 1-3 with weight 2.0.
* *
* Usage <code>SimpleCommunityDetection &lt;edge path&gt; &lt;result path&gt; * Usage <code>CommunityDetection &lt;edge path&gt; &lt;result path&gt;
* &lt;number of iterations&gt; &lt;delta&gt;</code><br> * &lt;number of iterations&gt; &lt;delta&gt;</code><br>
* If no parameters are provided, the program is run with default data from * If no parameters are provided, the program is run with default data from
* {@link org.apache.flink.graph.example.utils.SimpleCommunityDetectionData} * {@link org.apache.flink.graph.example.utils.CommunityDetectionData}
*/ */
public class SimpleCommunityDetectionExample implements ProgramDescription { public class CommunityDetection implements ProgramDescription {


@SuppressWarnings("serial") @SuppressWarnings("serial")
public static void main(String [] args) throws Exception { public static void main(String [] args) throws Exception {
Expand All @@ -73,7 +73,7 @@ public Long map(Long label) throws Exception {
// the result is in the form of <vertexId, communityId>, where the communityId is the label // the result is in the form of <vertexId, communityId>, where the communityId is the label
// which the vertex converged to // which the vertex converged to
DataSet<Vertex<Long, Long>> communityVertices = DataSet<Vertex<Long, Long>> communityVertices =
graph.run(new SimpleCommunityDetection(maxIterations, delta)).getVertices(); graph.run(new CommunityDetectionAlgorithm(maxIterations, delta)).getVertices();


// emit result // emit result
if (fileOutput) { if (fileOutput) {
Expand All @@ -82,12 +82,12 @@ public Long map(Long label) throws Exception {
communityVertices.print(); communityVertices.print();
} }


env.execute("Executing Simple Community Detection Example"); env.execute("Executing Community Detection Example");
} }


@Override @Override
public String getDescription() { public String getDescription() {
return "Simple Community Detection Example"; return "Community Detection";
} }


// ************************************************************************* // *************************************************************************
Expand All @@ -97,13 +97,13 @@ public String getDescription() {
private static boolean fileOutput = false; private static boolean fileOutput = false;
private static String edgeInputPath = null; private static String edgeInputPath = null;
private static String outputPath = null; private static String outputPath = null;
private static Integer maxIterations = SimpleCommunityDetectionData.MAX_ITERATIONS; private static Integer maxIterations = CommunityDetectionData.MAX_ITERATIONS;
private static Double delta = SimpleCommunityDetectionData.DELTA; private static Double delta = CommunityDetectionData.DELTA;


private static boolean parseParameters(String [] args) { private static boolean parseParameters(String [] args) {
if(args.length > 0) { if(args.length > 0) {
if(args.length != 4) { if(args.length != 4) {
System.err.println("Usage SimpleCommunityDetection <edge path> <output path> " + System.err.println("Usage CommunityDetection <edge path> <output path> " +
"<num iterations> <delta>"); "<num iterations> <delta>");
return false; return false;
} }
Expand All @@ -117,7 +117,7 @@ private static boolean parseParameters(String [] args) {
} else { } else {
System.out.println("Executing SimpleCommunityDetection example with default parameters and built-in default data."); System.out.println("Executing SimpleCommunityDetection example with default parameters and built-in default data.");
System.out.println("Provide parameters to read input data from files."); System.out.println("Provide parameters to read input data from files.");
System.out.println("Usage SimpleCommunityDetection <edge path> <output path> " + System.out.println("Usage CommunityDetection <edge path> <output path> " +
"<num iterations> <delta>"); "<num iterations> <delta>");
} }


Expand All @@ -134,7 +134,7 @@ private static DataSet<Edge<Long, Double>> getEdgesDataSet(ExecutionEnvironment
.types(Long.class, Long.class, Double.class) .types(Long.class, Long.class, Double.class)
.map(new Tuple3ToEdgeMap<Long, Double>()); .map(new Tuple3ToEdgeMap<Long, Double>());
} else { } else {
return SimpleCommunityDetectionData.getDefaultEdgeDataSet(env); return CommunityDetectionData.getDefaultEdgeDataSet(env);
} }
} }
} }
16 changes: 8 additions & 8 deletions ...h/example/ConnectedComponentsExample.java → ...nk/graph/example/ConnectedComponents.java
View file
Expand Up @@ -26,12 +26,12 @@
import org.apache.flink.graph.Edge; import org.apache.flink.graph.Edge;
import org.apache.flink.graph.Graph; import org.apache.flink.graph.Graph;
import org.apache.flink.graph.Vertex; import org.apache.flink.graph.Vertex;
import org.apache.flink.graph.example.utils.ConnectedComponentsExampleData; import org.apache.flink.graph.example.utils.ConnectedComponentsDefaultData;
import org.apache.flink.graph.library.ConnectedComponents; import org.apache.flink.graph.library.ConnectedComponentsAlgorithm;
import org.apache.flink.types.NullValue; import org.apache.flink.types.NullValue;


/** /**
* This example shows how to use the {@link org.apache.flink.graph.library.ConnectedComponents} * This example shows how to use the {@link org.apache.flink.graph.library.ConnectedComponentsAlgorithm}
* library method: * library method:
* <ul> * <ul>
* <li> with the edge data set given as a parameter * <li> with the edge data set given as a parameter
Expand All @@ -47,9 +47,9 @@
* Usage <code>ConnectedComponents &lt;edge path&gt; &lt;result path&gt; * Usage <code>ConnectedComponents &lt;edge path&gt; &lt;result path&gt;
* &lt;number of iterations&gt; </code><br> * &lt;number of iterations&gt; </code><br>
* If no parameters are provided, the program is run with default data from * If no parameters are provided, the program is run with default data from
* {@link org.apache.flink.graph.example.utils.ConnectedComponentsExampleData} * {@link org.apache.flink.graph.example.utils.ConnectedComponentsDefaultData}
*/ */
public class ConnectedComponentsExample implements ProgramDescription { public class ConnectedComponents implements ProgramDescription {


@SuppressWarnings("serial") @SuppressWarnings("serial")
public static void main(String [] args) throws Exception { public static void main(String [] args) throws Exception {
Expand All @@ -70,7 +70,7 @@ public Long map(Long value) throws Exception {
}, env); }, env);


DataSet<Vertex<Long, Long>> verticesWithMinIds = graph DataSet<Vertex<Long, Long>> verticesWithMinIds = graph
.run(new ConnectedComponents(maxIterations)).getVertices(); .run(new ConnectedComponentsAlgorithm(maxIterations)).getVertices();


// emit result // emit result
if (fileOutput) { if (fileOutput) {
Expand All @@ -94,7 +94,7 @@ public String getDescription() {
private static boolean fileOutput = false; private static boolean fileOutput = false;
private static String edgeInputPath = null; private static String edgeInputPath = null;
private static String outputPath = null; private static String outputPath = null;
private static Integer maxIterations = ConnectedComponentsExampleData.MAX_ITERATIONS; private static Integer maxIterations = ConnectedComponentsDefaultData.MAX_ITERATIONS;


private static boolean parseParameters(String [] args) { private static boolean parseParameters(String [] args) {
if(args.length > 0) { if(args.length > 0) {
Expand Down Expand Up @@ -135,7 +135,7 @@ public Edge<Long, NullValue> map(Tuple2<Long, Long> value) throws Exception {
} }
}); });
} else { } else {
return ConnectedComponentsExampleData.getDefaultEdgeDataSet(env); return ConnectedComponentsDefaultData.getDefaultEdgeDataSet(env);
} }
} }
} }
10 changes: 5 additions & 5 deletions .../graph/example/EuclideanGraphExample.java → ...graph/example/EuclideanGraphWeighing.java
View file
Expand Up @@ -49,12 +49,12 @@
* </ul> * </ul>
* </p> * </p>
* *
* Usage <code>EuclideanGraphExample &lt;vertex path&gt; &lt;edge path&gt; &lt;result path&gt;</code><br> * Usage <code>EuclideanGraphWeighing &lt;vertex path&gt; &lt;edge path&gt; &lt;result path&gt;</code><br>
* If no parameters are provided, the program is run with default data from * If no parameters are provided, the program is run with default data from
* {@link org.apache.flink.graph.example.utils.EuclideanGraphData} * {@link org.apache.flink.graph.example.utils.EuclideanGraphData}
*/ */
@SuppressWarnings("serial") @SuppressWarnings("serial")
public class EuclideanGraphExample implements ProgramDescription { public class EuclideanGraphWeighing implements ProgramDescription {


public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {


Expand Down Expand Up @@ -105,7 +105,7 @@ public Double map(Tuple2<Double, Double> distance) throws Exception {
result.print(); result.print();
} }


env.execute("Euclidean Graph Example"); env.execute("Euclidean Graph Weighing Example");
} }


@Override @Override
Expand Down Expand Up @@ -163,10 +163,10 @@ private static boolean parseParameters(String[] args) {
edgesInputPath = args[1]; edgesInputPath = args[1];
outputPath = args[2]; outputPath = args[2];
} else { } else {
System.out.println("Executing Euclidean Graph example with default parameters and built-in default data."); System.out.println("Executing Euclidean Graph Weighing example with default parameters and built-in default data.");
System.out.println("Provide parameters to read input data from files."); System.out.println("Provide parameters to read input data from files.");
System.out.println("See the documentation for the correct format of input files."); System.out.println("See the documentation for the correct format of input files.");
System.err.println("Usage: EuclideanGraphExample <input vertices path> <input edges path>" + System.err.println("Usage: EuclideanGraphWeighing <input vertices path> <input edges path>" +
" <output path>"); " <output path>");
return false; return false;
} }
Expand Down
8 changes: 4 additions & 4 deletions ...xample/GSAConnectedComponentsExample.java → ...graph/example/GSAConnectedComponents.java
View file
Expand Up @@ -37,7 +37,7 @@
/** /**
* This is an implementation of the Connected Components algorithm, using a gather-sum-apply iteration * This is an implementation of the Connected Components algorithm, using a gather-sum-apply iteration
*/ */
public class GSAConnectedComponentsExample implements ProgramDescription { public class GSAConnectedComponents implements ProgramDescription {


// -------------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------------
// Program // Program
Expand Down Expand Up @@ -109,7 +109,7 @@ public void apply(Long summedValue, Long origValue) {
setResult(summedValue); setResult(summedValue);
} }
} }
}; }


// -------------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------------
// Util methods // Util methods
Expand All @@ -128,7 +128,7 @@ private static boolean parseParameters(String[] args) {
fileOutput = true; fileOutput = true;


if (args.length != 3) { if (args.length != 3) {
System.err.println("Usage: GSAConnectedComponentsExample <edge path> " + System.err.println("Usage: GSAConnectedComponents <edge path> " +
"<result path> <max iterations>"); "<result path> <max iterations>");
return false; return false;
} }
Expand All @@ -140,7 +140,7 @@ private static boolean parseParameters(String[] args) {
System.out.println("Executing GSA Connected Components example with built-in default data."); System.out.println("Executing GSA Connected Components example with built-in default data.");
System.out.println(" Provide parameters to read input data from files."); System.out.println(" Provide parameters to read input data from files.");
System.out.println(" See the documentation for the correct format of input files."); System.out.println(" See the documentation for the correct format of input files.");
System.out.println(" Usage: GSAConnectedComponentsExample <edge path> <result path> <max iterations>"); System.out.println(" Usage: GSAConnectedComponents <edge path> <result path> <max iterations>");
} }
return true; return true;
} }
Expand Down
6 changes: 3 additions & 3 deletions .../GSASingleSourceShortestPathsExample.java → ...example/GSASingleSourceShortestPaths.java
View file
Expand Up @@ -35,7 +35,7 @@
/** /**
* This is an implementation of the Single Source Shortest Paths algorithm, using a gather-sum-apply iteration * This is an implementation of the Single Source Shortest Paths algorithm, using a gather-sum-apply iteration
*/ */
public class GSASingleSourceShortestPathsExample implements ProgramDescription { public class GSASingleSourceShortestPaths implements ProgramDescription {


// -------------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------------
// Program // Program
Expand Down Expand Up @@ -68,7 +68,7 @@ public static void main(String[] args) throws Exception {
singleSourceShortestPaths.print(); singleSourceShortestPaths.print();
} }


env.execute("GSA Single Source Shortest Paths Example"); env.execute("GSA Single Source Shortest Paths");
} }


@SuppressWarnings("serial") @SuppressWarnings("serial")
Expand Down Expand Up @@ -118,7 +118,7 @@ public void apply(Double newDistance, Double oldDistance) {
setResult(newDistance); setResult(newDistance);
} }
} }
}; }


// -------------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------------
// Util methods // Util methods
Expand Down
8 changes: 4 additions & 4 deletions ...mple/JaccardSimilarityMeasureExample.java → ...aph/example/JaccardSimilarityMeasure.java
View file
Expand Up @@ -49,12 +49,12 @@
* For example: <code>1 2\n1 3\n</code> defines two edges 1-2 and 1-3. * For example: <code>1 2\n1 3\n</code> defines two edges 1-2 and 1-3.
* </p> * </p>
* *
* Usage <code> JaccardSimilarityMeasureExample &lt;edge path&gt; &lt;result path&gt;</code><br> * Usage <code> JaccardSimilarityMeasure &lt;edge path&gt; &lt;result path&gt;</code><br>
* If no parameters are provided, the program is run with default data from * If no parameters are provided, the program is run with default data from
* {@link org.apache.flink.graph.example.utils.JaccardSimilarityMeasureData} * {@link org.apache.flink.graph.example.utils.JaccardSimilarityMeasureData}
*/ */
@SuppressWarnings("serial") @SuppressWarnings("serial")
public class JaccardSimilarityMeasureExample implements ProgramDescription { public class JaccardSimilarityMeasure implements ProgramDescription {


public static void main(String [] args) throws Exception { public static void main(String [] args) throws Exception {


Expand Down Expand Up @@ -177,7 +177,7 @@ private static Long getNeighborID(Tuple2<Long, Edge<Long, Double>> edge) {
private static boolean parseParameters(String [] args) { private static boolean parseParameters(String [] args) {
if(args.length > 0) { if(args.length > 0) {
if(args.length != 2) { if(args.length != 2) {
System.err.println("Usage JaccardSimilarityMeasureExample <edge path> <output path>"); System.err.println("Usage JaccardSimilarityMeasure <edge path> <output path>");
return false; return false;
} }


Expand All @@ -187,7 +187,7 @@ private static boolean parseParameters(String [] args) {
} else { } else {
System.out.println("Executing JaccardSimilarityMeasure example with default parameters and built-in default data."); System.out.println("Executing JaccardSimilarityMeasure example with default parameters and built-in default data.");
System.out.println("Provide parameters to read input data from files."); System.out.println("Provide parameters to read input data from files.");
System.out.println("Usage JaccardSimilarityMeasureExample <edge path> <output path>"); System.out.println("Usage JaccardSimilarityMeasure <edge path> <output path>");
} }


return true; return true;
Expand Down
6 changes: 3 additions & 3 deletions ...raph/example/LabelPropagationExample.java → ...flink/graph/example/LabelPropagation.java
View file
Expand Up @@ -27,7 +27,7 @@
import org.apache.flink.graph.Edge; import org.apache.flink.graph.Edge;
import org.apache.flink.graph.Graph; import org.apache.flink.graph.Graph;
import org.apache.flink.graph.Vertex; import org.apache.flink.graph.Vertex;
import org.apache.flink.graph.library.LabelPropagation; import org.apache.flink.graph.library.LabelPropagationAlgorithm;
import org.apache.flink.graph.utils.Tuple2ToVertexMap; import org.apache.flink.graph.utils.Tuple2ToVertexMap;
import org.apache.flink.types.NullValue; import org.apache.flink.types.NullValue;
import org.apache.flink.util.Collector; import org.apache.flink.util.Collector;
Expand All @@ -48,7 +48,7 @@
* *
* If no arguments are provided, the example runs with a random graph of 100 vertices. * If no arguments are provided, the example runs with a random graph of 100 vertices.
*/ */
public class LabelPropagationExample implements ProgramDescription { public class LabelPropagation implements ProgramDescription {


public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {


Expand All @@ -67,7 +67,7 @@ public static void main(String[] args) throws Exception {


// Set up the program // Set up the program
DataSet<Vertex<Long, Long>> verticesWithCommunity = graph.run( DataSet<Vertex<Long, Long>> verticesWithCommunity = graph.run(
new LabelPropagation<Long>(maxIterations)).getVertices(); new LabelPropagationAlgorithm<Long>(maxIterations)).getVertices();


// Emit results // Emit results
if(fileOutput) { if(fileOutput) {
Expand Down
4 changes: 2 additions & 2 deletions flink-staging/flink-gelly/src/main/java/org/apache/flink/graph/example/MusicProfiles.java
View file
Expand Up @@ -37,7 +37,7 @@
import org.apache.flink.graph.Graph; import org.apache.flink.graph.Graph;
import org.apache.flink.graph.Vertex; import org.apache.flink.graph.Vertex;
import org.apache.flink.graph.example.utils.MusicProfilesData; import org.apache.flink.graph.example.utils.MusicProfilesData;
import org.apache.flink.graph.library.LabelPropagation; import org.apache.flink.graph.library.LabelPropagationAlgorithm;
import org.apache.flink.types.NullValue; import org.apache.flink.types.NullValue;
import org.apache.flink.util.Collector; import org.apache.flink.util.Collector;


Expand Down Expand Up @@ -140,7 +140,7 @@ public Long map(String value) {
public Long map(Tuple2<Long, Long> value) { public Long map(Tuple2<Long, Long> value) {
return value.f1; return value.f1;
} }
}).run(new LabelPropagation<String>(maxIterations)) }).run(new LabelPropagationAlgorithm<String>(maxIterations))
.getVertices(); .getVertices();


if (fileOutput) { if (fileOutput) {
Expand Down
6 changes: 3 additions & 3 deletions .../flink/graph/example/PageRankExample.java → .../apache/flink/graph/example/PageRank.java
View file
Expand Up @@ -27,7 +27,7 @@
import org.apache.flink.graph.Edge; import org.apache.flink.graph.Edge;
import org.apache.flink.graph.Graph; import org.apache.flink.graph.Graph;
import org.apache.flink.graph.Vertex; import org.apache.flink.graph.Vertex;
import org.apache.flink.graph.library.PageRank; import org.apache.flink.graph.library.PageRankAlgorithm;
import org.apache.flink.graph.utils.Tuple3ToEdgeMap; import org.apache.flink.graph.utils.Tuple3ToEdgeMap;
import org.apache.flink.util.Collector; import org.apache.flink.util.Collector;


Expand All @@ -41,7 +41,7 @@
* and random edge weights. * and random edge weights.
* *
*/ */
public class PageRankExample implements ProgramDescription { public class PageRank implements ProgramDescription {


@SuppressWarnings("serial") @SuppressWarnings("serial")
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
Expand Down Expand Up @@ -73,7 +73,7 @@ public Double map(Tuple2<Double, Long> value) {
}); });


DataSet<Vertex<Long, Double>> pageRanks = networkWithWeights.run( DataSet<Vertex<Long, Double>> pageRanks = networkWithWeights.run(
new PageRank<Long>(DAMPENING_FACTOR, maxIterations)) new PageRankAlgorithm<Long>(DAMPENING_FACTOR, maxIterations))
.getVertices(); .getVertices();


if (fileOutput) { if (fileOutput) {
Expand Down
6 changes: 3 additions & 3 deletions ...ple/SingleSourceShortestPathsExample.java → ...ph/example/SingleSourceShortestPaths.java
View file
Expand Up @@ -26,7 +26,7 @@
import org.apache.flink.graph.Graph; import org.apache.flink.graph.Graph;
import org.apache.flink.graph.Vertex; import org.apache.flink.graph.Vertex;
import org.apache.flink.graph.example.utils.SingleSourceShortestPathsData; import org.apache.flink.graph.example.utils.SingleSourceShortestPathsData;
import org.apache.flink.graph.library.SingleSourceShortestPaths; import org.apache.flink.graph.library.SingleSourceShortestPathsAlgorithm;
import org.apache.flink.graph.utils.Tuple3ToEdgeMap; import org.apache.flink.graph.utils.Tuple3ToEdgeMap;


/** /**
Expand All @@ -40,7 +40,7 @@
* If no arguments are provided, the example runs with default data from {@link SingleSourceShortestPathsData}. * If no arguments are provided, the example runs with default data from {@link SingleSourceShortestPathsData}.
* *
*/ */
public class SingleSourceShortestPathsExample implements ProgramDescription { public class SingleSourceShortestPaths implements ProgramDescription {


@SuppressWarnings("serial") @SuppressWarnings("serial")
public static void main(String[] args) throws Exception { public static void main(String[] args) throws Exception {
Expand All @@ -62,7 +62,7 @@ public Double map(Long value) {
}, env); }, env);


DataSet<Vertex<Long, Double>> singleSourceShortestPaths = graph DataSet<Vertex<Long, Double>> singleSourceShortestPaths = graph
.run(new SingleSourceShortestPaths<Long>(srcVertexId, maxIterations)) .run(new SingleSourceShortestPathsAlgorithm<Long>(srcVertexId, maxIterations))
.getVertices(); .getVertices();


// emit result // emit result
Expand Down
4 changes: 2 additions & 2 deletions ...e/utils/SimpleCommunityDetectionData.java → ...example/utils/CommunityDetectionData.java
View file
Expand Up @@ -29,7 +29,7 @@
* Provides the default data set used for the Simple Community Detection example program. * Provides the default data set used for the Simple Community Detection example program.
* If no parameters are given to the program, the default edge data set is used. * If no parameters are given to the program, the default edge data set is used.
*/ */
public class SimpleCommunityDetectionData { public class CommunityDetectionData {


// the algorithm is not guaranteed to always converge // the algorithm is not guaranteed to always converge
public static final Integer MAX_ITERATIONS = 30; public static final Integer MAX_ITERATIONS = 30;
Expand Down Expand Up @@ -61,5 +61,5 @@ public static DataSet<Edge<Long, Double>> getDefaultEdgeDataSet(ExecutionEnviron
return env.fromCollection(edges); return env.fromCollection(edges);
} }


private SimpleCommunityDetectionData() {} private CommunityDetectionData() {}
} }

0 comments on commit 8f4039d

Please sign in to comment.