org.deeplearning4j.berkeley.PriorityQueueInterface Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.0.0-M2.1

/*-
 *
 *  * Copyright 2015 Skymind,Inc.
 *  *
 *  *    Licensed under the Apache License, Version 2.0 (the "License");
 *  *    you may not use this file except in compliance with the License.
 *  *    You may obtain a copy of the License at
 *  *
 *  *        http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  *    Unless required by applicable law or agreed to in writing, software
 *  *    distributed under the License is distributed on an "AS IS" BASIS,
 *  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  *    See the License for the specific language governing permissions and
 *  *    limitations under the License.
 *
 */

package org.deeplearning4j.berkeley;

public interface PriorityQueueInterface {

    /**
     * Returns true if the priority queue is non-empty
     */
    boolean hasNext();

    /**
     * Returns the element in the queue with highest priority, and pops it from
     * the queue.
     */
    E next();

    /**
     * Not supported -- next() already removes the head of the queue.
     */
    void remove();

    /**
     * Returns the highest-priority element in the queue, but does not pop it.
     */
    E peek();

    /**
     * Gets the priority of the highest-priority element of the queue.
     */
    double getPriority();

    /**
     * Number of elements in the queue.
     */
    int size();

    /**
     * True if the queue is empty (size == 0).
     */
    boolean isEmpty();

    /**
     * Adds a key to the queue with the given priority.  If the key is already in
     * the queue, it will be added an additional time, NOT promoted/demoted.
     *
     * @param key
     * @param priority
     */
    void put(E key, double priority);

}