Package org.neo4j.gds.similarity.nodesim

Record Class NodeSimilarityEstimateParameters

java.lang.Object
java.lang.Record
org.neo4j.gds.similarity.nodesim.NodeSimilarityEstimateParameters
public record NodeSimilarityEstimateParameters(int normalizedK, int normalizedN, boolean useComponents, boolean runWCC, boolean computeToGraph) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    NodeSimilarityEstimateParameters(int normalizedK, int normalizedN, boolean useComponents, boolean runWCC, boolean computeToGraph)
    Creates an instance of a NodeSimilarityEstimateParameters record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    computeToGraph()
    Returns the value of the computeToGraph 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.
    int
    normalizedK()
    Returns the value of the normalizedK record component.
    int
    normalizedN()
    Returns the value of the normalizedN record component.
    boolean
    runWCC()
    Returns the value of the runWCC record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    useComponents()
    Returns the value of the useComponents record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • NodeSimilarityEstimateParameters

      public NodeSimilarityEstimateParameters(int normalizedK, int normalizedN, boolean useComponents, boolean runWCC, boolean computeToGraph)
      Creates an instance of a NodeSimilarityEstimateParameters record class.
      Parameters:
      normalizedK - the value for the normalizedK record component
      normalizedN - the value for the normalizedN record component
      useComponents - the value for the useComponents record component
      runWCC - the value for the runWCC record component
      computeToGraph - the value for the computeToGraph 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. All components in this record class 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.

    • normalizedK

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

    • normalizedN

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

    • useComponents

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

    • runWCC

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

    • computeToGraph

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