Package org.neo4j.gds.api
Enum AdjacencyCursor.EmptyAdjacencyCursor
- java.lang.Object
-
- java.lang.Enum<AdjacencyCursor.EmptyAdjacencyCursor>
-
- org.neo4j.gds.api.AdjacencyCursor.EmptyAdjacencyCursor
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.AutoCloseable
,java.lang.Comparable<AdjacencyCursor.EmptyAdjacencyCursor>
,AdjacencyCursor
- Enclosing interface:
- AdjacencyCursor
public static enum AdjacencyCursor.EmptyAdjacencyCursor extends java.lang.Enum<AdjacencyCursor.EmptyAdjacencyCursor> implements AdjacencyCursor
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.neo4j.gds.api.AdjacencyCursor
AdjacencyCursor.EmptyAdjacencyCursor
-
-
Enum Constant Summary
Enum Constants Enum Constant Description INSTANCE
-
Field Summary
-
Fields inherited from interface org.neo4j.gds.api.AdjacencyCursor
NOT_FOUND
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
advance(long nodeId)
Read and decode target ids until it is larger than or equal (>=) the providedtarget
.void
close()
boolean
hasNextVLong()
Return true iff there is at least one more target to decode.void
init(long index, int degree)
Initialize this cursor to point to the givenindex
.long
nextVLong()
Read and decode the next target id.long
peekVLong()
Decode and peek the next target id.int
remaining()
Return how many targets are still left to be decoded.@NotNull AdjacencyCursor
shallowCopy(@Nullable AdjacencyCursor destination)
Create a shallow copy of this cursor.int
size()
Return how many targets can be decoded in total.long
skipUntil(long nodeId)
Read and decode target ids until it is strictly larger than (>) the providedtarget
.static AdjacencyCursor.EmptyAdjacencyCursor
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AdjacencyCursor.EmptyAdjacencyCursor[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INSTANCE
public static final AdjacencyCursor.EmptyAdjacencyCursor INSTANCE
-
-
Method Detail
-
values
public static AdjacencyCursor.EmptyAdjacencyCursor[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (AdjacencyCursor.EmptyAdjacencyCursor c : AdjacencyCursor.EmptyAdjacencyCursor.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AdjacencyCursor.EmptyAdjacencyCursor valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
init
public void init(long index, int degree)
Description copied from interface:AdjacencyCursor
Initialize this cursor to point to the givenindex
. The correct value for the index is highly implementation specific. The better way get initialize a cursor is throughAdjacencyList.adjacencyCursor(long)
or related.- Specified by:
init
in interfaceAdjacencyCursor
-
size
public int size()
Description copied from interface:AdjacencyCursor
Return how many targets can be decoded in total. This is equivalent to the degree.- Specified by:
size
in interfaceAdjacencyCursor
-
hasNextVLong
public boolean hasNextVLong()
Description copied from interface:AdjacencyCursor
Return true iff there is at least one more target to decode.- Specified by:
hasNextVLong
in interfaceAdjacencyCursor
-
nextVLong
public long nextVLong()
Description copied from interface:AdjacencyCursor
Read and decode the next target id. It is undefined behavior if this is called afterAdjacencyCursor.hasNextVLong()
returnsfalse
.- Specified by:
nextVLong
in interfaceAdjacencyCursor
-
peekVLong
public long peekVLong()
Description copied from interface:AdjacencyCursor
Decode and peek the next target id. Does not progress the internal cursor unlikeAdjacencyCursor.nextVLong()
. It is undefined behavior if this is called afterAdjacencyCursor.hasNextVLong()
returnsfalse
.- Specified by:
peekVLong
in interfaceAdjacencyCursor
-
remaining
public int remaining()
Description copied from interface:AdjacencyCursor
Return how many targets are still left to be decoded.- Specified by:
remaining
in interfaceAdjacencyCursor
-
skipUntil
public long skipUntil(long nodeId)
Description copied from interface:AdjacencyCursor
Read and decode target ids until it is strictly larger than (>) the providedtarget
. If there are no such targets before this cursor is exhausted,-1
is returned.- Specified by:
skipUntil
in interfaceAdjacencyCursor
-
advance
public long advance(long nodeId)
Description copied from interface:AdjacencyCursor
Read and decode target ids until it is larger than or equal (>=) the providedtarget
. If there are no such targets before this cursor is exhausted,-1
is returned.- Specified by:
advance
in interfaceAdjacencyCursor
-
shallowCopy
@NotNull public @NotNull AdjacencyCursor shallowCopy(@Nullable @Nullable AdjacencyCursor destination)
Description copied from interface:AdjacencyCursor
Create a shallow copy of this cursor. Iteration state is copied and will advance independently from this cursor. The underlying data might be shared between instances. If the provideddestination
argument is not null, it might be re-used instead of having to create a new instance. It is *not* guaranteed that thedestination
will be reused. If thedestination
is not if the same type than this cursor, the behavior of this method in undefined.- Specified by:
shallowCopy
in interfaceAdjacencyCursor
-
close
public void close()
- Specified by:
close
in interfaceAdjacencyCursor
- Specified by:
close
in interfacejava.lang.AutoCloseable
-
-