Package org.neo4j.gds.api
Class GraphCharacteristics
- java.lang.Object
-
- org.neo4j.gds.api.GraphCharacteristics
-
public final class GraphCharacteristics extends java.lang.Object
Graph characteristics describe certain capabilities of the graph.Algorithms define the graph characteristics that they require to for correct execution. The execution framework can use both, the graph and the required characteristics to check if the algorithm can be run on the given graph.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GraphCharacteristics.Builder
-
Field Summary
Fields Modifier and Type Field Description static GraphCharacteristics
ALL
static GraphCharacteristics
NONE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GraphCharacteristics.Builder
builder()
boolean
equals(java.lang.Object o)
int
hashCode()
GraphCharacteristics
intersect(GraphCharacteristics other)
Intersects the characteristics with the given one and returns a new characteristics instance.boolean
isDirected()
boolean
isInverseIndexed()
boolean
isUndirected()
java.lang.String
toString()
-
-
-
Field Detail
-
ALL
public static final GraphCharacteristics ALL
-
NONE
public static final GraphCharacteristics NONE
-
-
Method Detail
-
builder
public static GraphCharacteristics.Builder builder()
-
isDirected
public boolean isDirected()
-
isUndirected
public boolean isUndirected()
-
isInverseIndexed
public boolean isInverseIndexed()
-
intersect
public GraphCharacteristics intersect(GraphCharacteristics other)
Intersects the characteristics with the given one and returns a new characteristics instance. The resulting object will contain only those characteristics that are present in both inputs.- Parameters:
other
- the characteristics to intersect with- Returns:
- a new `GraphCharacteristics` object that contains the shared characteristics of the input
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-