Package org.neo4j.gds.similarity

Class CosineProc

  • public class CosineProc
extends org.neo4j.gds.AlgoBaseProc<ALGO,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​CONFIG>

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.neo4j.gds.AlgoBaseProc

        org.neo4j.gds.AlgoBaseProc.ComputationResult<A extends org.neo4j.gds.Algorithm<A,​RESULT>,​RESULT extends java.lang.Object,​CONFIG extends org.neo4j.gds.config.AlgoBaseConfig>

      • Nested classes/interfaces inherited from class org.neo4j.gds.BaseProc

        org.neo4j.gds.BaseProc.FreeMemoryInspector

    • 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, username

    • Constructor Summary

      Constructors 
      Constructor Description
      CosineProc()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.neo4j.gds.AlgorithmFactory<ALGO,​CONFIG> algorithmFactory()  
      java.util.stream.Stream<AlphaSimilarityStatsResult> cosineStats​(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      java.util.stream.Stream<org.neo4j.gds.results.SimilarityResult> cosineStream​(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      java.util.stream.Stream<AlphaSimilaritySummaryResult> cosineWrite​(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      protected org.neo4j.gds.impl.similarity.CosineConfig newConfig​(java.lang.String username, java.util.Optional<java.lang.String> graphName, java.util.Optional<org.neo4j.gds.config.GraphCreateConfig> maybeImplicitCreate, org.neo4j.gds.core.CypherMapWrapper userInput)  
      org.eclipse.collections.api.tuple.Pair<CONFIG,​java.util.Optional<java.lang.String>> processInput​(java.lang.Object graphNameOrConfig, java.util.Map<java.lang.String,​java.lang.Object> configuration)  

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

        compute, compute, computeEstimate, getOrCreateGraphStore, newConfig, nodeProperties, procName, sharedConfigKeys, validateConfigsAfterLoad, validateConfigsBeforeLoad, validateConfigWithGraphStore

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

        allocationTracker, catalogRequest, databaseId, estimateGraphCreate, graphStoreFromCatalog, isGdsAdmin, newLoader, runWithExceptionLogging, runWithExceptionLogging, tryValidateMemoryUsage, tryValidateMemoryUsage, username, validateConfig, validateConfig, validateGraphName

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SIMILARITY_FAKE_GRAPH_NAME

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

    • Constructor Detail

      • CosineProc

        public CosineProc()

    • Method Detail

      • cosineStream

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

      • cosineWrite

        public java.util.stream.Stream<AlphaSimilaritySummaryResult> cosineWrite​(java.lang.Object graphNameOrConfig,
                                                                         java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • cosineStats

        public java.util.stream.Stream<AlphaSimilarityStatsResult> cosineStats​(java.lang.Object graphNameOrConfig,
                                                                       java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • newConfig

        protected org.neo4j.gds.impl.similarity.CosineConfig newConfig​(java.lang.String username,
                                                               java.util.Optional<java.lang.String> graphName,
                                                               java.util.Optional<org.neo4j.gds.config.GraphCreateConfig> maybeImplicitCreate,
                                                               org.neo4j.gds.core.CypherMapWrapper userInput)
        Specified by:
        newConfig in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.impl.similarity.CosineAlgorithm,​org.neo4j.gds.impl.similarity.SimilarityAlgorithmResult,​org.neo4j.gds.impl.similarity.CosineConfig>

      • algorithmFactory

        protected final org.neo4j.gds.AlgorithmFactory<ALGO,​CONFIG> algorithmFactory()
        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>

      • processInput

        public org.eclipse.collections.api.tuple.Pair<CONFIG,​java.util.Optional<java.lang.String>> processInput​(java.lang.Object graphNameOrConfig,
                                                                                                              java.util.Map<java.lang.String,​java.lang.Object> configuration)
        Overrides:
        processInput 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>