[15/50] [abbrv] tinkerpop git commit: Added javadoc for all the modulators CTR
Added javadoc for all the modulators CTR Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/372dfd80 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/372dfd80 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/372dfd80 Branch: refs/heads/TINKERPOP-1612 Commit: 372dfd80123c9e987eac8805891561bc45bc840b Parents: c7d666d Author: Stephen Mallette Authored: Fri Feb 17 16:02:15 2017 -0500 Committer: Stephen Mallette Committed: Fri Feb 17 16:02:15 2017 -0500 -- .../traversal/dsl/graph/GraphTraversal.java | 165 +-- 1 file changed, 155 insertions(+), 10 deletions(-) -- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/372dfd80/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java -- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java index eaf2cc1..a8624e6 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java @@ -2219,26 +2219,58 @@ public interface GraphTraversal extends Traversal { /// VERTEX PROGRAM STEPS +/** + * Calculates a PageRank over the graph using a 0.85 for the {@code alpha} value. + * + * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step + */ public default GraphTraversal pageRank() { return this.pageRank(0.85d); } +/** + * Calculates a PageRank over the graph. + * + * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step + */ public default GraphTraversal pageRank(final double alpha) { this.asAdmin().getBytecode().addStep(Symbols.pageRank, alpha); return this.asAdmin().addStep((Step) new PageRankVertexProgramStep(this.asAdmin(), alpha)); } +/** + * Executes a Peer Pressure community detection algorithm over the graph. + * + * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step + */ public default GraphTraversal peerPressure() { this.asAdmin().getBytecode().addStep(Symbols.peerPressure); return this.asAdmin().addStep((Step) new PeerPressureVertexProgramStep(this.asAdmin())); } +/** + * Executes a Peer Pressure community detection algorithm over the graph. + * + * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step + */ public default GraphTraversal program(final VertexProgram vertexProgram) { return this.asAdmin().addStep((Step) new ProgramVertexProgramStep(this.asAdmin(), vertexProgram)); } / UTILITY STEPS / +/** + * A step modulator that provides a lable to the step that can be accessed later in the traversal by other steps. + * + * @param stepLabel the name of the step + * @param stepLabels additional names for the label + * @return the traversal with the modified end step + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#as-step"; target="_blank">Reference Documentation - As Step + */ public default GraphTraversal as(final String stepLabel, final String... stepLabels) { this.asAdmin().getBytecode().addStep(Symbols.as, stepLabel, stepLabels); if (this.asAdmin().getSteps().size() == 0) this.asAdmin().addStep(new StartStep<>(this.asAdmin())); @@ -2250,15 +2282,40 @@ public interface GraphTraversal extends Traversal { return this; } +/** + * Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to + * the size of the barrier. In this case, it iterates the entire thing as the default barrier size is set to + * {@code Integer.MAX_VALUE}. + * +
tinkerpop git commit: Added javadoc for all the modulators CTR
Repository: tinkerpop Updated Branches: refs/heads/tp32 c7d666ddb -> 372dfd801 Added javadoc for all the modulators CTR Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/372dfd80 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/372dfd80 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/372dfd80 Branch: refs/heads/tp32 Commit: 372dfd80123c9e987eac8805891561bc45bc840b Parents: c7d666d Author: Stephen Mallette Authored: Fri Feb 17 16:02:15 2017 -0500 Committer: Stephen Mallette Committed: Fri Feb 17 16:02:15 2017 -0500 -- .../traversal/dsl/graph/GraphTraversal.java | 165 +-- 1 file changed, 155 insertions(+), 10 deletions(-) -- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/372dfd80/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java -- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java index eaf2cc1..a8624e6 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java @@ -2219,26 +2219,58 @@ public interface GraphTraversal extends Traversal { /// VERTEX PROGRAM STEPS +/** + * Calculates a PageRank over the graph using a 0.85 for the {@code alpha} value. + * + * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step + */ public default GraphTraversal pageRank() { return this.pageRank(0.85d); } +/** + * Calculates a PageRank over the graph. + * + * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step + */ public default GraphTraversal pageRank(final double alpha) { this.asAdmin().getBytecode().addStep(Symbols.pageRank, alpha); return this.asAdmin().addStep((Step) new PageRankVertexProgramStep(this.asAdmin(), alpha)); } +/** + * Executes a Peer Pressure community detection algorithm over the graph. + * + * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step + */ public default GraphTraversal peerPressure() { this.asAdmin().getBytecode().addStep(Symbols.peerPressure); return this.asAdmin().addStep((Step) new PeerPressureVertexProgramStep(this.asAdmin())); } +/** + * Executes a Peer Pressure community detection algorithm over the graph. + * + * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step + */ public default GraphTraversal program(final VertexProgram vertexProgram) { return this.asAdmin().addStep((Step) new ProgramVertexProgramStep(this.asAdmin(), vertexProgram)); } / UTILITY STEPS / +/** + * A step modulator that provides a lable to the step that can be accessed later in the traversal by other steps. + * + * @param stepLabel the name of the step + * @param stepLabels additional names for the label + * @return the traversal with the modified end step + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#as-step"; target="_blank">Reference Documentation - As Step + */ public default GraphTraversal as(final String stepLabel, final String... stepLabels) { this.asAdmin().getBytecode().addStep(Symbols.as, stepLabel, stepLabels); if (this.asAdmin().getSteps().size() == 0) this.asAdmin().addStep(new StartStep<>(this.asAdmin())); @@ -2250,15 +2282,40 @@ public interface GraphTraversal extends Traversal { return this; } +/** + * Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to + * the size of the barrier. In this case, it iterates the entire thing as the defa
[1/2] tinkerpop git commit: Added javadoc for all the modulators CTR
Repository: tinkerpop Updated Branches: refs/heads/master 9a3818173 -> db6d52178 Added javadoc for all the modulators CTR Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/372dfd80 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/372dfd80 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/372dfd80 Branch: refs/heads/master Commit: 372dfd80123c9e987eac8805891561bc45bc840b Parents: c7d666d Author: Stephen Mallette Authored: Fri Feb 17 16:02:15 2017 -0500 Committer: Stephen Mallette Committed: Fri Feb 17 16:02:15 2017 -0500 -- .../traversal/dsl/graph/GraphTraversal.java | 165 +-- 1 file changed, 155 insertions(+), 10 deletions(-) -- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/372dfd80/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java -- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java index eaf2cc1..a8624e6 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java @@ -2219,26 +2219,58 @@ public interface GraphTraversal extends Traversal { /// VERTEX PROGRAM STEPS +/** + * Calculates a PageRank over the graph using a 0.85 for the {@code alpha} value. + * + * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step + */ public default GraphTraversal pageRank() { return this.pageRank(0.85d); } +/** + * Calculates a PageRank over the graph. + * + * @return the traversal with the appended {@link PageRankVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#pagerank-step"; target="_blank">Reference Documentation - PageRank Step + */ public default GraphTraversal pageRank(final double alpha) { this.asAdmin().getBytecode().addStep(Symbols.pageRank, alpha); return this.asAdmin().addStep((Step) new PageRankVertexProgramStep(this.asAdmin(), alpha)); } +/** + * Executes a Peer Pressure community detection algorithm over the graph. + * + * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step + */ public default GraphTraversal peerPressure() { this.asAdmin().getBytecode().addStep(Symbols.peerPressure); return this.asAdmin().addStep((Step) new PeerPressureVertexProgramStep(this.asAdmin())); } +/** + * Executes a Peer Pressure community detection algorithm over the graph. + * + * @return the traversal with the appended {@link PeerPressureVertexProgramStep} + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#peerpressure-step"; target="_blank">Reference Documentation - PeerPressure Step + */ public default GraphTraversal program(final VertexProgram vertexProgram) { return this.asAdmin().addStep((Step) new ProgramVertexProgramStep(this.asAdmin(), vertexProgram)); } / UTILITY STEPS / +/** + * A step modulator that provides a lable to the step that can be accessed later in the traversal by other steps. + * + * @param stepLabel the name of the step + * @param stepLabels additional names for the label + * @return the traversal with the modified end step + * @see http://tinkerpop.apache.org/docs/${project.version}/reference/#as-step"; target="_blank">Reference Documentation - As Step + */ public default GraphTraversal as(final String stepLabel, final String... stepLabels) { this.asAdmin().getBytecode().addStep(Symbols.as, stepLabel, stepLabels); if (this.asAdmin().getSteps().size() == 0) this.asAdmin().addStep(new StartStep<>(this.asAdmin())); @@ -2250,15 +2282,40 @@ public interface GraphTraversal extends Traversal { return this; } +/** + * Turns the lazy traversal pipeline into a bulk-synchronous pipeline which basically iterates that traversal to + * the size of the barrier. In this case, it iterates the entire thing as the