Path finding spec moving

Author: IoannisPanagiotas

algorithm-specifications/build.gradle

@@ -9,6 +9,8 @@ dependencies {
 
     implementation project(':algo')
     implementation project(':algo-common')
+    implementation project(':algorithms-facade-common')
+
     implementation project(':algorithms-machinery')
 
     // `CypherMapWrapper`
@@ -24,6 +26,8 @@ dependencies {
     implementation project(':node-embeddings-facade-api')
 
     implementation project(':path-finding-configs')
+    implementation project(':path-finding-facade-api')
+
 
     // `BaseConfig`
     implementation project(':config-api')
@@ -46,6 +50,8 @@ dependencies {
 
     implementation project(':progress-tracking')
 
+    implementation project(':termination')
+
     integrationTestImplementation project(':proc-catalog')
     integrationTestImplementation project(':proc-test')
     integrationTestImplementation project(':test-utils')

proc/path-finding/src/main/java/org/neo4j/gds/paths/all/AllShortestPathsStreamSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/allshortest/AllShortestPathsStreamSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.all;
+package org.neo4j.gds.allshortest;
 
 import org.neo4j.gds.AlgorithmFactory;
 import org.neo4j.gds.GraphAlgorithmFactory;
@@ -40,12 +40,11 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.STREAM;
-import static org.neo4j.gds.paths.all.Constants.ALL_PAIRS_SHORTEST_PATH_DESCRIPTION;
 
 @GdsCallable(
     name = "gds.allShortestPaths.stream",
     aliases = "gds.alpha.allShortestPaths.stream",
-    description = ALL_PAIRS_SHORTEST_PATH_DESCRIPTION,
+    description = Constants.ALL_PAIRS_SHORTEST_PATH_DESCRIPTION,
     executionMode = STREAM
 )
 public class AllShortestPathsStreamSpec implements AlgorithmSpec<MSBFSASPAlgorithm, Stream<AllShortestPathsStreamResult>, AllShortestPathsConfig, Stream<AllShortestPathsStreamResult>, AlgorithmFactory<Graph, MSBFSASPAlgorithm, AllShortestPathsConfig>> {

algorithm-specifications/src/main/java/org/neo4j/gds/allshortest/Constants.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.allshortest;
+
+final class Constants {
+    static final String ALL_PAIRS_SHORTEST_PATH_DESCRIPTION = "The All Pairs Shortest Path (APSP) calculates the shortest (weighted) path between all pairs of nodes.";
+
+    private Constants() {}
+}

algorithm-specifications/src/main/java/org/neo4j/gds/astar/Constants.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.astar;
+
+class Constants {
+    static final String ASTAR_DESCRIPTION =
+        "The A* shortest path algorithm computes the shortest path between a pair of nodes. " +
+            "It uses the relationship weight property to compare path lengths. " +
+            "In addition, this implementation uses the haversine distance as a heuristic to converge faster.";
+
+}

proc/path-finding/src/main/java/org/neo4j/gds/paths/sourcetarget/ShortestPathAStarMutateSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/astar/ShortestPathAStarMutateSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.sourcetarget;
+package org.neo4j.gds.astar;
 
 import org.neo4j.gds.NullComputationResultConsumer;
 import org.neo4j.gds.executor.AlgorithmSpec;
@@ -34,9 +34,8 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.MUTATE_RELATIONSHIP;
-import static org.neo4j.gds.paths.sourcetarget.SinglePairShortestPathConstants.ASTAR_DESCRIPTION;
 
-@GdsCallable(name = "gds.shortestPath.astar.mutate", description = ASTAR_DESCRIPTION, executionMode = MUTATE_RELATIONSHIP)
+@GdsCallable(name = "gds.shortestPath.astar.mutate", description = Constants.ASTAR_DESCRIPTION, executionMode = MUTATE_RELATIONSHIP)
 public class ShortestPathAStarMutateSpec implements AlgorithmSpec<AStar, PathFindingResult, ShortestPathAStarMutateConfig, Stream<PathFindingMutateResult>, AStarFactory<ShortestPathAStarMutateConfig>> {
 
     @Override

proc/path-finding/src/main/java/org/neo4j/gds/paths/sourcetarget/ShortestPathAStarStreamSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/astar/ShortestPathAStarStreamSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.sourcetarget;
+package org.neo4j.gds.astar;
 
 import org.neo4j.gds.NullComputationResultConsumer;
 import org.neo4j.gds.executor.AlgorithmSpec;
@@ -34,9 +34,8 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.STREAM;
-import static org.neo4j.gds.paths.sourcetarget.SinglePairShortestPathConstants.ASTAR_DESCRIPTION;
 
-@GdsCallable(name = "gds.shortestPath.astar.stream", description = ASTAR_DESCRIPTION, executionMode = STREAM)
+@GdsCallable(name = "gds.shortestPath.astar.stream", description = Constants.ASTAR_DESCRIPTION, executionMode = STREAM)
 public class ShortestPathAStarStreamSpec implements AlgorithmSpec<AStar, PathFindingResult, ShortestPathAStarStreamConfig, Stream<PathFindingStreamResult>, AStarFactory<ShortestPathAStarStreamConfig>> {
 
     @Override

proc/path-finding/src/main/java/org/neo4j/gds/paths/sourcetarget/ShortestPathAStarWriteSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/astar/ShortestPathAStarWriteSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.sourcetarget;
+package org.neo4j.gds.astar;
 
 import org.neo4j.gds.NullComputationResultConsumer;
 import org.neo4j.gds.executor.AlgorithmSpec;
@@ -34,9 +34,8 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.WRITE_RELATIONSHIP;
-import static org.neo4j.gds.paths.sourcetarget.SinglePairShortestPathConstants.ASTAR_DESCRIPTION;
 
-@GdsCallable(name = "gds.shortestPath.astar.write", description = ASTAR_DESCRIPTION, executionMode = WRITE_RELATIONSHIP)
+@GdsCallable(name = "gds.shortestPath.astar.write", description = Constants.ASTAR_DESCRIPTION, executionMode = WRITE_RELATIONSHIP)
 public class ShortestPathAStarWriteSpec implements AlgorithmSpec<AStar, PathFindingResult, ShortestPathAStarWriteConfig, Stream<StandardWriteRelationshipsResult>, AStarFactory<ShortestPathAStarWriteConfig>> {
 
     @Override

proc/path-finding/src/main/java/org/neo4j/gds/paths/singlesource/bellmanford/BellmanFordMutateSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/bellmanFord/BellmanFordMutateSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.singlesource.bellmanford;
+package org.neo4j.gds.bellmanFord;
 
 import org.neo4j.gds.NullComputationResultConsumer;
 import org.neo4j.gds.executor.AlgorithmSpec;
@@ -34,9 +34,8 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.MUTATE_RELATIONSHIP;
-import static org.neo4j.gds.paths.singlesource.SingleSourceShortestPathConstants.BELLMAN_FORD_DESCRIPTION;
 
-@GdsCallable(name = "gds.bellmanFord.mutate", description = BELLMAN_FORD_DESCRIPTION, executionMode = MUTATE_RELATIONSHIP)
+@GdsCallable(name = "gds.bellmanFord.mutate", description = Constants.BELLMAN_FORD_DESCRIPTION, executionMode = MUTATE_RELATIONSHIP)
 public class BellmanFordMutateSpec implements AlgorithmSpec<BellmanFord, BellmanFordResult, AllShortestPathsBellmanFordMutateConfig, Stream<BellmanFordMutateResult>, BellmanFordAlgorithmFactory<AllShortestPathsBellmanFordMutateConfig>> {
 
     @Override

proc/path-finding/src/main/java/org/neo4j/gds/paths/singlesource/bellmanford/BellmanFordStatsSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/bellmanFord/BellmanFordStatsSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.singlesource.bellmanford;
+package org.neo4j.gds.bellmanFord;
 
 import org.neo4j.gds.NullComputationResultConsumer;
 import org.neo4j.gds.executor.AlgorithmSpec;
@@ -34,9 +34,8 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.STATS;
-import static org.neo4j.gds.paths.singlesource.SingleSourceShortestPathConstants.BELLMAN_FORD_DESCRIPTION;
 
-@GdsCallable(name = "gds.bellmanFord.stats", description = BELLMAN_FORD_DESCRIPTION, executionMode = STATS)
+@GdsCallable(name = "gds.bellmanFord.stats", description = Constants.BELLMAN_FORD_DESCRIPTION, executionMode = STATS)
 public class BellmanFordStatsSpec implements AlgorithmSpec<BellmanFord, BellmanFordResult, AllShortestPathsBellmanFordStatsConfig, Stream<BellmanFordStatsResult>, BellmanFordAlgorithmFactory<AllShortestPathsBellmanFordStatsConfig>> {
     @Override
     public String name() {

proc/path-finding/src/main/java/org/neo4j/gds/paths/singlesource/bellmanford/BellmanFordStreamSpec.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/bellmanFord/BellmanFordStreamSpec.java

@@ -17,7 +17,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.paths.singlesource.bellmanford;
+package org.neo4j.gds.bellmanFord;
 
 import org.neo4j.gds.NullComputationResultConsumer;
 import org.neo4j.gds.executor.AlgorithmSpec;
@@ -34,9 +34,8 @@
 import java.util.stream.Stream;
 
 import static org.neo4j.gds.executor.ExecutionMode.STREAM;
-import static org.neo4j.gds.paths.singlesource.SingleSourceShortestPathConstants.BELLMAN_FORD_DESCRIPTION;
 
-@GdsCallable(name = "gds.bellmanFord.stream", description = BELLMAN_FORD_DESCRIPTION, executionMode = STREAM)
+@GdsCallable(name = "gds.bellmanFord.stream", description = Constants.BELLMAN_FORD_DESCRIPTION, executionMode = STREAM)
 public class BellmanFordStreamSpec implements
     AlgorithmSpec<BellmanFord, BellmanFordResult, AllShortestPathsBellmanFordStreamConfig, Stream<BellmanFordStreamResult>, BellmanFordAlgorithmFactory<AllShortestPathsBellmanFordStreamConfig>> {