Package org.neo4j.gds.similarity.nodesim

Record Class NodeSimilarityParameters

java.lang.Object

java.lang.Record

org.neo4j.gds.similarity.nodesim.NodeSimilarityParameters

public record NodeSimilarityParameters(MetricSimilarityComputer similarityComputer, int degreeCutoff, int upperDegreeCutoff, int normalizedK, int normalizedN, boolean computeToStream, boolean hasRelationshipWeightProperty, boolean useComponents, @Nullable String componentProperty)
extends Record

Constructor Summary

Constructors

Constructor	Description
NodeSimilarityParameters(MetricSimilarityComputer similarityComputer, int degreeCutoff, int upperDegreeCutoff, int normalizedK, int normalizedN, boolean computeToStream, boolean hasRelationshipWeightProperty, boolean useComponents, @Nullable String componentProperty)	Creates an instance of a NodeSimilarityParameters record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	componentProperty()	Returns the value of the componentProperty record component.
boolean	computeToStream()	Returns the value of the computeToStream record component.
int	degreeCutoff()	Returns the value of the degreeCutoff 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.
boolean	hasRelationshipWeightProperty()	Returns the value of the hasRelationshipWeightProperty record component.
NodeSimilarityEstimateParameters	memoryParameters()
int	normalizedK()	Returns the value of the normalizedK record component.
int	normalizedN()	Returns the value of the normalizedN record component.
MetricSimilarityComputer	similarityComputer()	Returns the value of the similarityComputer record component.
final String	toString()	Returns a string representation of this record class.
int	upperDegreeCutoff()	Returns the value of the upperDegreeCutoff record component.
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

NodeSimilarityParameters

public NodeSimilarityParameters(MetricSimilarityComputer similarityComputer,
 int degreeCutoff,
 int upperDegreeCutoff,
 int normalizedK,
 int normalizedN,
 boolean computeToStream,
 boolean hasRelationshipWeightProperty,
 boolean useComponents,
 @Nullable
 @Nullable String componentProperty)

Creates an instance of a NodeSimilarityParameters record class.

Parameters:

similarityComputer - the value for the similarityComputer record component

degreeCutoff - the value for the degreeCutoff record component

upperDegreeCutoff - the value for the upperDegreeCutoff record component

normalizedK - the value for the normalizedK record component

normalizedN - the value for the normalizedN record component

computeToStream - the value for the computeToStream record component

hasRelationshipWeightProperty - the value for the hasRelationshipWeightProperty record component

useComponents - the value for the useComponents record component

componentProperty - the value for the componentProperty record component

Method Details

memoryParameters

public NodeSimilarityEstimateParameters memoryParameters()

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.

similarityComputer

public MetricSimilarityComputer similarityComputer()

Returns the value of the similarityComputer record component.

Returns:

the value of the similarityComputer record component

degreeCutoff

public int degreeCutoff()

Returns the value of the degreeCutoff record component.

Returns:

the value of the degreeCutoff record component

upperDegreeCutoff

public int upperDegreeCutoff()

Returns the value of the upperDegreeCutoff record component.

Returns:

the value of the upperDegreeCutoff record component

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

computeToStream

public boolean computeToStream()

Returns the value of the computeToStream record component.

Returns:

the value of the computeToStream record component

hasRelationshipWeightProperty

public boolean hasRelationshipWeightProperty()

Returns the value of the hasRelationshipWeightProperty record component.

Returns:

the value of the hasRelationshipWeightProperty record component

useComponents

public boolean useComponents()

Returns the value of the useComponents record component.

Returns:

the value of the useComponents record component

componentProperty

@Nullable
public @Nullable String componentProperty()

Returns the value of the componentProperty record component.

Returns:

the value of the componentProperty record component