org.deeplearning4j.graph.iterator.GraphWalkIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deeplearning4j-graph Show documentation

There is a newer version: 1.0.0-M2.1

package org.deeplearning4j.graph.iterator;

import org.deeplearning4j.graph.api.IVertexSequence;

/**Interface/iterator representing a sequence of walks on a graph
 * For example, a {@code GraphWalkIterator} can represesnt a set of independent random walks on a graph
 */
public interface GraphWalkIterator {

    /** Length of the walks returned by next()
     * Note that a walk of length {@code i} contains {@code i+1} vertices
     */
    int walkLength();

    /**Get the next vertex sequence.
     */
    IVertexSequence next();

    /** Whether the iterator has any more vertex sequences. */
    boolean hasNext();

    /** Reset the graph walk iterator. */
    void reset();
}