Package org.neo4j.gds.similarity

Class AlphaSimilarityProc<ALGO extends org.neo4j.gds.impl.similarity.SimilarityAlgorithm<ALGO,​?>,​CONFIG extends org.neo4j.gds.impl.similarity.SimilarityConfig,​PROC_RESULT>

  • All Implemented Interfaces:
    org.neo4j.gds.executor.AlgorithmSpec<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<PROC_RESULT>,​org.neo4j.gds.AlgorithmFactory<?,​ALGO,​CONFIG>>
    Direct Known Subclasses:
    ApproxNearestNeighborsProc, CosineProc, EuclideanProc, OverlapProc, PearsonProc
    public abstract class AlphaSimilarityProc<ALGO extends org.neo4j.gds.impl.similarity.SimilarityAlgorithm<ALGO,​?>,​CONFIG extends org.neo4j.gds.impl.similarity.SimilarityConfig,​PROC_RESULT>
extends org.neo4j.gds.AlgoBaseProc<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​PROC_RESULT>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String SIMILARITY_FAKE_GRAPH_NAME  

      • Fields inherited from class org.neo4j.gds.AlgoBaseProc

        STATS_DESCRIPTION

      • Fields inherited from class org.neo4j.gds.BaseProc

        allocationTracker, api, callContext, ESTIMATE_DESCRIPTION, log, procedureTransaction, taskRegistryFactory, transaction, userLogRegistryFactory, username

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.neo4j.gds.GraphAlgorithmFactory<ALGO,​CONFIG> algorithmFactory()  
      org.neo4j.gds.executor.ProcConfigParser<CONFIG> configParser()  
      protected abstract ALGO newAlgo​(CONFIG config, org.neo4j.gds.core.utils.mem.AllocationTracker allocationTracker)  
      protected java.util.stream.Stream<AlphaSimilarityStatsResult> stats​(java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      protected org.neo4j.gds.executor.ComputationResultConsumer<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<AlphaSimilarityStatsResult>> statsResultConsumer()  
      protected java.util.stream.Stream<org.neo4j.gds.results.SimilarityResult> stream​(java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      protected org.neo4j.gds.executor.ComputationResultConsumer<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<org.neo4j.gds.results.SimilarityResult>> streamResultConsumer()  
      protected abstract java.lang.String taskName()  
      protected java.util.stream.Stream<AlphaSimilaritySummaryResult> write​(java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      protected org.neo4j.gds.executor.ComputationResultConsumer<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<AlphaSimilaritySummaryResult>> writeResultConsumer()  

      • Methods inherited from class org.neo4j.gds.AlgoBaseProc

        compute, compute, computeEstimate, name, newConfig, newConfigFunction, nodeProperties, validationConfig, validator

      • Methods inherited from class org.neo4j.gds.BaseProc

        allocationTracker, databaseId, executionContext, graphLoaderContext, graphStoreFromCatalog, isGdsAdmin, memoryUsageValidator, runWithExceptionLogging, runWithExceptionLogging, username, validateConfig, validateConfig, validateGraphName

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.neo4j.gds.executor.AlgorithmSpec

        computationResultConsumer

    • Field Detail

      • SIMILARITY_FAKE_GRAPH_NAME

        public static final java.lang.String SIMILARITY_FAKE_GRAPH_NAME
        See Also:
        Constant Field Values

    • Constructor Detail

      • AlphaSimilarityProc

        public AlphaSimilarityProc()

    • Method Detail

      • stream

        protected java.util.stream.Stream<org.neo4j.gds.results.SimilarityResult> stream​(java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • streamResultConsumer

        protected org.neo4j.gds.executor.ComputationResultConsumer<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<org.neo4j.gds.results.SimilarityResult>> streamResultConsumer()

      • write

        protected java.util.stream.Stream<AlphaSimilaritySummaryResult> write​(java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • writeResultConsumer

        protected org.neo4j.gds.executor.ComputationResultConsumer<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<AlphaSimilaritySummaryResult>> writeResultConsumer()

      • stats

        protected java.util.stream.Stream<AlphaSimilarityStatsResult> stats​(java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • statsResultConsumer

        protected org.neo4j.gds.executor.ComputationResultConsumer<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG,​java.util.stream.Stream<AlphaSimilarityStatsResult>> statsResultConsumer()

      • newAlgo

        protected abstract ALGO newAlgo​(CONFIG config,
                                org.neo4j.gds.core.utils.mem.AllocationTracker allocationTracker)

      • taskName

        protected abstract java.lang.String taskName()

      • algorithmFactory

        public final org.neo4j.gds.GraphAlgorithmFactory<ALGO,​CONFIG> algorithmFactory()
        Specified by:
        algorithmFactory in interface org.neo4j.gds.executor.AlgorithmSpec<ALGO extends org.neo4j.gds.impl.similarity.SimilarityAlgorithm<ALGO,​?>,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG extends org.neo4j.gds.impl.similarity.SimilarityConfig,​java.util.stream.Stream<PROC_RESULT>,​org.neo4j.gds.AlgorithmFactory<?,​ALGO extends org.neo4j.gds.impl.similarity.SimilarityAlgorithm<ALGO,​?>,​CONFIG extends org.neo4j.gds.impl.similarity.SimilarityConfig>>
        Specified by:
        algorithmFactory in class org.neo4j.gds.AlgoBaseProc<ALGO extends org.neo4j.gds.impl.similarity.SimilarityAlgorithm<ALGO,​?>,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG extends org.neo4j.gds.impl.similarity.SimilarityConfig,​PROC_RESULT>

      • configParser

        public org.neo4j.gds.executor.ProcConfigParser<CONFIG> configParser()
        Overrides:
        configParser in class org.neo4j.gds.AlgoBaseProc<ALGO extends org.neo4j.gds.impl.similarity.SimilarityAlgorithm<ALGO,​?>,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG extends org.neo4j.gds.impl.similarity.SimilarityConfig,​PROC_RESULT>