Package org.neo4j.gds.leiden

Interface LeidenBaseConfig

  • All Superinterfaces:
    org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.ConsecutiveIdsConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.SeedConfig, org.neo4j.gds.config.ToleranceConfig, org.neo4j.gds.config.ToMapConvertible
    All Known Subinterfaces:
    LeidenMutateConfig, LeidenStatsConfig, LeidenStreamConfig, LeidenWriteConfig
    public interface LeidenBaseConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.ConsecutiveIdsConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.ToleranceConfig

    • Field Summary

      • 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

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

        SEED_PROPERTY_KEY

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default double gamma()  
      default boolean includeIntermediateCommunities()  
      default int maxLevels()  
      default double theta()  
      default double tolerance()  
      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.ConsecutiveIdsConfig

        consecutiveIds, forbidSeedingAndConsecutiveIds

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

        jobId

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

        randomSeed

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

        hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation, validateRelationshipWeightProperty

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

        isIncremental, seedProperty, validateSeedProperty

    • Method Detail

      • gamma

        @Default
default double gamma()

      • theta

        @Default
default double theta()

      • maxLevels

        @Default
default int maxLevels()

      • includeIntermediateCommunities

        @Default
default boolean includeIntermediateCommunities()

      • tolerance

        @Default
@DoubleRange(min=0.0)
default double tolerance()
        Specified by:
        tolerance in interface org.neo4j.gds.config.ToleranceConfig

      • validate

        @Check
default void validate()