Package org.neo4j.gds.similarity.nodesim

Interface NodeSimilarityBaseConfig

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BOTTOM_K_DEFAULT  
      static java.lang.String BOTTOM_K_KEY  
      static int BOTTOM_N_DEFAULT  
      static java.lang.String BOTTOM_N_KEY  
      static int TOP_K_DEFAULT  
      static java.lang.String TOP_K_KEY  
      static int TOP_N_DEFAULT  
      static java.lang.String TOP_N_KEY  

      • Fields inherited from interface org.neo4j.gds.config.AlgoBaseConfig

        NODE_LABELS_KEY, RELATIONSHIP_TYPES_KEY

      • Fields inherited from interface org.neo4j.gds.config.BaseConfig

        LOG_PROGRESS_KEY, SUDO_KEY

      • Fields inherited from interface org.neo4j.gds.config.ConcurrencyConfig

        CONCURRENCY_KEY, CONCURRENCY_LIMITATION, DEFAULT_CONCURRENCY

      • Fields inherited from interface org.neo4j.gds.config.RelationshipWeightConfig

        RELATIONSHIP_WEIGHT_PROPERTY

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default int bottomK()  
      default int bottomN()  
      default boolean computeToGraph()  
      default boolean computeToStream()  
      default int degreeCutoff()  
      default boolean hasTopK()  
      default boolean hasTopN()  
      default boolean isParallel()  
      default int normalizedK()  
      default int normalizedN()  
      default double similarityCutoff()  
      default MetricSimilarityComputer.MetricSimilarityComputerBuilder similarityMetric()  
      default int topK()  
      default int topN()  
      default void validate()  

      • Methods inherited from interface org.neo4j.gds.config.AlgoBaseConfig

        graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, nodeLabels, relationshipTypes, validateNodeLabels, validateRelationshipTypes

      • Methods inherited from interface org.neo4j.gds.config.BaseConfig

        configKeys, logProgress, sudo, toMap, usernameOverride

      • Methods inherited from interface org.neo4j.gds.config.ConcurrencyConfig

        concurrency, minBatchSize, validateConcurrency

      • Methods inherited from interface org.neo4j.gds.config.JobIdConfig

        jobId

      • Methods inherited from interface org.neo4j.gds.config.RelationshipWeightConfig

        hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation, validateRelationshipWeightProperty

    • Method Detail

      • similarityCutoff

        @Default
@DoubleRange(min=0.0,
             max=1.0)
default double similarityCutoff()

      • similarityMetric

        @Default
@ConvertWith(method="org.neo4j.gds.similarity.nodesim.MetricSimilarityComputer#parse")
@ToMapValue("org.neo4j.gds.similarity.nodesim.MetricSimilarityComputer#render")
default MetricSimilarityComputer.MetricSimilarityComputerBuilder similarityMetric()

      • degreeCutoff

        @Default
@IntegerRange(min=1)
default int degreeCutoff()

      • topK

        @Default
@Key("topK")
@IntegerRange(min=1)
default int topK()

      • topN

        @Default
@Key("topN")
@IntegerRange(min=0)
default int topN()

      • bottomK

        @Default
@Key("bottomK")
@IntegerRange(min=1)
default int bottomK()

      • bottomN

        @Default
@Key("bottomN")
@IntegerRange(min=0)
default int bottomN()

      • normalizedK

        @Ignore
@Derived
default int normalizedK()

      • normalizedN

        @Ignore
@Derived
default int normalizedN()

      • isParallel

        @Ignore
@Derived
default boolean isParallel()

      • hasTopK

        @Ignore
@Derived
default boolean hasTopK()

      • hasTopN

        @Ignore
@Derived
default boolean hasTopN()

      • computeToStream

        @Ignore
default boolean computeToStream()

      • computeToGraph

        @Ignore
@Derived
default boolean computeToGraph()

      • validate

        @Check
default void validate()