Package org.neo4j.gds.labelpropagation

Record Class LabelPropagationResult

java.lang.Object
java.lang.Record
org.neo4j.gds.labelpropagation.LabelPropagationResult
public record LabelPropagationResult(org.neo4j.gds.collections.ha.HugeLongArray labels, boolean didConverge, long ranIterations) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    LabelPropagationResult(org.neo4j.gds.collections.ha.HugeLongArray labels, boolean didConverge, long ranIterations)
    Creates an instance of a LabelPropagationResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    didConverge()
    Returns the value of the didConverge 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.
    org.neo4j.gds.collections.ha.HugeLongArray
    labels()
    Returns the value of the labels record component.
    long
    ranIterations()
    Returns the value of the ranIterations 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

    • LabelPropagationResult

      public LabelPropagationResult(org.neo4j.gds.collections.ha.HugeLongArray labels, boolean didConverge, long ranIterations)
      Creates an instance of a LabelPropagationResult record class.
      Parameters:
      labels - the value for the labels record component
      didConverge - the value for the didConverge record component
      ranIterations - the value for the ranIterations 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.

    • labels

      public org.neo4j.gds.collections.ha.HugeLongArray labels()
      Returns the value of the labels record component.
      Returns:
      the value of the labels record component

    • didConverge

      public boolean didConverge()
      Returns the value of the didConverge record component.
      Returns:
      the value of the didConverge record component

    • ranIterations

      public long ranIterations()
      Returns the value of the ranIterations record component.
      Returns:
      the value of the ranIterations record component