Java example source code file (GraphWalkIterator.java)

This example Java source code file (GraphWalkIterator.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

graphwalkiterator, ivertexsequence

The GraphWalkIterator.java Java example source code

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<T>} can represesnt a set of independent random walks on a graph
 */
public interface GraphWalkIterator<T> {

    /** 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<T> next();

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

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