Package org.neo4j.gds.similarity.filteredknn

Class FilteredKnn

java.lang.Object

org.neo4j.gds.Algorithm<FilteredKnnResult>

org.neo4j.gds.similarity.filteredknn.FilteredKnn

public class FilteredKnn
extends org.neo4j.gds.Algorithm<FilteredKnnResult>

Filtered KNN is the same as ordinary KNN, _but_ we allow users to regulate final output in two ways. Consider each result item to be a relationship from one node to another, with a score. Firstly, we enable source node filtering. This limits the result to only contain relationships where the source node matches the filter. Secondly, we enable target node filtering. This limits the result to only contain relationships where the target node matches the filter. In both cases the source or target node set can be actual specified nodes, or it could be all nodes with a label.

Field Summary

Fields inherited from class org.neo4j.gds.Algorithm

progressTracker, terminationFlag

Method Summary

Modifier and Type	Method	Description
FilteredKnnResult	compute()
static FilteredKnn	createWithDefaultSeeding(org.neo4j.gds.api.Graph graph, FilteredKnnBaseConfig config, KnnContext context)
static FilteredKnn	createWithoutSeeding(org.neo4j.gds.api.Graph graph, FilteredKnnBaseConfig config, KnnContext context)
void	release()

Methods inherited from class org.neo4j.gds.Algorithm

getProgressTracker, getTerminationFlag, setTerminationFlag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createWithoutSeeding

public static FilteredKnn createWithoutSeeding(org.neo4j.gds.api.Graph graph,
                                               FilteredKnnBaseConfig config,
                                               KnnContext context)

createWithDefaultSeeding

public static FilteredKnn createWithDefaultSeeding(org.neo4j.gds.api.Graph graph,
                                                   FilteredKnnBaseConfig config,
                                                   KnnContext context)

compute

public FilteredKnnResult compute()

Specified by:

compute in class org.neo4j.gds.Algorithm<FilteredKnnResult>

release

public void release()

Specified by:

release in class org.neo4j.gds.Algorithm<FilteredKnnResult>