org.jheaps.ValueHeap Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright 2014-2016, by Dimitrios Michail
 *
 * JHeaps Library
 * 
 * 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.jheaps;

import java.util.NoSuchElementException;

/**
 * A heap with values.
 *
 * @param 
 *            the type of keys maintained by this heap
 * @param 
 *            the type of values maintained by this heap
 *
 * @author Dimitrios Michail
 */
public interface ValueHeap extends Heap {

    /**
     * Insert an element into the heap.
     *
     * @param key
     *            the key to insert
     * @param value
     *            the value to insert
     */
    void insert(K key, V value);

    /**
     * Find the value of an element with the minimum key.
     *
     * @return the value of an element with the minimum key
     * @throws NoSuchElementException
     *             if the heap is empty
     */
    V findMinValue();

}