org.nd4j.linalg.dataset.api.iterator.ParallelDataSetIterator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nd4j-api Show documentation

There is a newer version: 1.0.0-M2.1

package org.nd4j.linalg.dataset.api.iterator;

import org.nd4j.linalg.dataset.DataSet;

/**
 * @author [email protected]
 */
public interface ParallelDataSetIterator extends DataSetIterator {

    /**
     * This method sets consumer affinity to specific producer
     *
     * PLEASE NOTE: this method is optional, and it'll change only nextFor()/hasNextFor() mechanics
     */
    void attachThread(int producer);

    /**
     * Returns true, if attached producer has something in queue, false otherwise
     *
     * @return
     */
    boolean hasNextFor();

    /**
     * Returns true, if attached producer has something in queue, false otherwise
     *
     * @param consumer
     * @return
     */
    boolean hasNextFor(int consumer);

    /**
     * Returns next DataSet for given consumer
     *
     * @param consumer
     * @return
     */
    DataSet nextFor(int consumer);

    /**
     * Returns next DataSet for attached consumer
     *
     * @return
     */
    DataSet nextFor();
}