Package org.neo4j.gds.louvain

Interface LouvainBaseConfig

  • 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.IterationsConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.SeedConfig, org.neo4j.gds.config.ToleranceConfig, org.neo4j.gds.config.ToMapConvertible
    All Known Subinterfaces:
    LouvainMutateConfig, LouvainStatsConfig, LouvainStreamConfig, LouvainWriteConfig
    public interface LouvainBaseConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.SeedConfig, org.neo4j.gds.config.ConsecutiveIdsConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.ToleranceConfig, org.neo4j.gds.config.IterationsConfig

    • 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 boolean includeIntermediateCommunities()  
      default int maxIterations()  
      default int maxLevels()  
      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.RelationshipWeightConfig

        hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation, validateRelationshipWeightProperty

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

        isIncremental, seedProperty, validateSeedProperty

    • Method Detail

      • tolerance

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

      • maxIterations

        @Default
@IntegerRange(min=1)
default int maxIterations()
        Specified by:
        maxIterations in interface org.neo4j.gds.config.IterationsConfig

      • maxLevels

        @Default
default int maxLevels()

      • includeIntermediateCommunities

        @Default
default boolean includeIntermediateCommunities()

      • validate

        @Check
default void validate()