Package org.neo4j.gds.similarity.knn

Record Class KnnParameters

java.lang.Object
java.lang.Record
org.neo4j.gds.similarity.knn.KnnParameters
public record KnnParameters(org.neo4j.gds.core.concurrency.Concurrency concurrency, int maxIterations, double similarityCutoff, K kHolder, double perturbationRate, int randomJoins, int minBatchSize, KnnSampler.SamplerType samplerType, Optional<Long> randomSeed, List<KnnNodePropertySpec> nodePropertySpecs) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    KnnParameters(org.neo4j.gds.core.concurrency.Concurrency concurrency, int maxIterations, double similarityCutoff, K kHolder, double perturbationRate, int randomJoins, int minBatchSize, KnnSampler.SamplerType samplerType, Optional<Long> randomSeed, List<KnnNodePropertySpec> nodePropertySpecs)
    Creates an instance of a KnnParameters record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.neo4j.gds.core.concurrency.Concurrency
    concurrency()
    Returns the value of the concurrency record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    K
    kHolder()
    Returns the value of the kHolder record component.
    int
    maxIterations()
    Returns the value of the maxIterations record component.
    int
    minBatchSize()
    Returns the value of the minBatchSize record component.
    List<KnnNodePropertySpec>
    nodePropertySpecs()
    Returns the value of the nodePropertySpecs record component.
    double
    perturbationRate()
    Returns the value of the perturbationRate record component.
    int
    randomJoins()
    Returns the value of the randomJoins record component.
    Optional<Long>
    randomSeed()
    Returns the value of the randomSeed record component.
    KnnSampler.SamplerType
    samplerType()
    Returns the value of the samplerType record component.
    double
    similarityCutoff()
    Returns the value of the similarityCutoff record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • KnnParameters

      public KnnParameters(org.neo4j.gds.core.concurrency.Concurrency concurrency, int maxIterations, double similarityCutoff, K kHolder, double perturbationRate, int randomJoins, int minBatchSize, KnnSampler.SamplerType samplerType, Optional<Long> randomSeed, List<KnnNodePropertySpec> nodePropertySpecs)
      Creates an instance of a KnnParameters record class.
      Parameters:
      concurrency - the value for the concurrency record component
      maxIterations - the value for the maxIterations record component
      similarityCutoff - the value for the similarityCutoff record component
      kHolder - the value for the kHolder record component
      perturbationRate - the value for the perturbationRate record component
      randomJoins - the value for the randomJoins record component
      minBatchSize - the value for the minBatchSize record component
      samplerType - the value for the samplerType record component
      randomSeed - the value for the randomSeed record component
      nodePropertySpecs - the value for the nodePropertySpecs record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • concurrency

      public org.neo4j.gds.core.concurrency.Concurrency concurrency()
      Returns the value of the concurrency record component.
      Returns:
      the value of the concurrency record component

    • maxIterations

      public int maxIterations()
      Returns the value of the maxIterations record component.
      Returns:
      the value of the maxIterations record component

    • similarityCutoff

      public double similarityCutoff()
      Returns the value of the similarityCutoff record component.
      Returns:
      the value of the similarityCutoff record component

    • kHolder

      public K kHolder()
      Returns the value of the kHolder record component.
      Returns:
      the value of the kHolder record component

    • perturbationRate

      public double perturbationRate()
      Returns the value of the perturbationRate record component.
      Returns:
      the value of the perturbationRate record component

    • randomJoins

      public int randomJoins()
      Returns the value of the randomJoins record component.
      Returns:
      the value of the randomJoins record component

    • minBatchSize

      public int minBatchSize()
      Returns the value of the minBatchSize record component.
      Returns:
      the value of the minBatchSize record component

    • samplerType

      public KnnSampler.SamplerType samplerType()
      Returns the value of the samplerType record component.
      Returns:
      the value of the samplerType record component

    • randomSeed

      public Optional<Long> randomSeed()
      Returns the value of the randomSeed record component.
      Returns:
      the value of the randomSeed record component

    • nodePropertySpecs

      public List<KnnNodePropertySpec> nodePropertySpecs()
      Returns the value of the nodePropertySpecs record component.
      Returns:
      the value of the nodePropertySpecs record component