Merge pull request #9650 from vnickolov/similarity-facades-api-modules

Create `similarity-facade-api` module

Author: vnickolov

algo-params/similarity-params/build.gradle

@@ -0,0 +1,18 @@
+apply plugin: 'java-library'
+
+description = 'Neo4j Graph Data Science :: Similarity Algorithms Parameters'
+
+group = 'org.neo4j.gds'
+
+dependencies {
+    compileOnly openGds.jetbrains.annotations
+
+    implementation project(':annotations')
+    implementation project(':concurrency')
+    implementation project(':graph-projection-api')
+    implementation project(':string-formatting')
+
+    // Because of `Intersections`
+    // TODO: move Intersections out of `core`
+    implementation project(':core')
+}

algo/src/main/java/org/neo4j/gds/similarity/filteredknn/SeedingSummary.java renamed to algo-params/similarity-params/src/main/java/org/neo4j/gds/similarity/filteredknn/SeedingSummary.java

@@ -19,19 +19,10 @@
  */
 package org.neo4j.gds.similarity.filteredknn;
 
-import org.neo4j.gds.similarity.SimilarityResult;
 import org.neo4j.gds.similarity.knn.NeighbourConsumer;
 
-import java.util.stream.Stream;
-
 
 public interface TargetNodeFilter extends NeighbourConsumer {
-
-    
-    /**
-     * As part of an instrumentation of KNN this is a handy utility.
-     */
-    Stream<SimilarityResult> asSimilarityStream(long nodeId);
     /**
      * As part of an instrumentation of KNN this is a handy utility.
      */

algo/src/main/java/org/neo4j/gds/similarity/filteredknn/TargetNodeFilter.java renamed to algo-params/similarity-params/src/main/java/org/neo4j/gds/similarity/filteredknn/TargetNodeFilter.java

@@ -0,0 +1,36 @@
+/*
+ * 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.similarity.filteredknn;
+
+import org.neo4j.gds.similarity.knn.NeighbourConsumers;
+
+import java.util.function.LongPredicate;
+
+public interface TargetNodeFiltering extends NeighbourConsumers {
+
+    boolean isTargetNodeFiltered();
+
+
+    default SeedingSummary seedingSummary() {
+        return SeedingSummary.EMPTY_SEEDING_SUMMARY;
+    }
+
+    long numberOfSimilarityPairs(LongPredicate sourceNodePredicate);
+}