org.jheaps.AddressableHeap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of AptSpringProcessor Show documentation
This project contains the apt processor that implements all the checks enumerated in @Verify. It is a self contained, and shaded jar.
The newest version!
/*
 * (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.Comparator;

/**
 * A heap whose elements can be addressed using handles.
 *
 * An insert operation returns a {@link AddressableHeap.Handle} which can later
 * be used in order to manipulate the element, such as decreasing its key, or
 * deleting it. Storing the handle externally is the responsibility of the user.
 *
 * @param 
 *            the type of keys maintained by this heap
 * @param 
 *            the type of values maintained by this heap
 *
 * @author Dimitrios Michail
 */
public interface AddressableHeap {

    /**
     * A heap element handle. Allows someone to address an element already in a
     * heap and perform additional operations.
     *
     * @param 
     *            the type of keys maintained by this heap
     * @param 
     *            the type of values maintained by this heap
     */
    interface Handle {

        /**
         * Return the key of the element.
         *
         * @return the key of the element
         */
        K getKey();

        /**
         * Return the value of the element.
         *
         * @return the value of the element
         */
        V getValue();

        /**
         * Set the value of the element.
         * 
         * @param value
         *            the new value
         */
        void setValue(V value);

        /**
         * Decrease the key of the element.
         *
         * @param newKey
         *            the new key
         * @throws IllegalArgumentException
         *             if the new key is larger than the old key according to
         *             the comparator used when constructing the heap or the
         *             natural ordering of the elements if no comparator was
         *             used
         */
        void decreaseKey(K newKey);

        /**
         * Delete the element from the heap that it belongs.
         *
         * @throws IllegalArgumentException
         *             in case this function is called twice on the same element
         *             or the element has already been deleted using
         *             {@link AddressableHeap#deleteMin()}.
         */
        void delete();

    }

    /**
     * Returns the comparator used to order the keys in this AddressableHeap, or
     * {@code null} if this heap uses the {@linkplain Comparable natural
     * ordering} of its keys.
     *
     * @return the comparator used to order the keys in this heap, or
     *         {@code null} if this addressable heap uses the natural ordering
     *         of its keys
     */
    Comparator comparator();

    /**
     * Insert a new element into the heap.
     *
     * @param key
     *            the element's key
     * @param value
     *            the element's value
     * 
     * @return a handle for the newly added element
     */
    AddressableHeap.Handle insert(K key, V value);

    /**
     * Insert a new element into the heap with a null value.
     *
     * @param key
     *            the element's key
     * @return a handle for the newly added element
     */
    AddressableHeap.Handle insert(K key);

    /**
     * Find an element with the minimum key.
     *
     * @return a handle to an element with minimum key
     */
    AddressableHeap.Handle findMin();

    /**
     * Delete and return an element with the minimum key. If multiple such
     * elements exists, only one of them will be deleted. After the element is
     * deleted the handle is invalidated and only method {@link Handle#getKey()}
     * and {@link Handle#getValue()} can be used.
     * 
     * @return a handle to the deleted element with minimum key
     */
    AddressableHeap.Handle deleteMin();

    /**
     * Returns {@code true} if this heap is empty.
     *
     * @return {@code true} if this heap is empty, {@code false} otherwise
     */
    boolean isEmpty();

    /**
     * Returns the number of elements in the heap.
     *
     * @return the number of elements in the heap
     */
    long size();

    /**
     * Clear all the elements of the heap. After calling this method all handles
     * should be considered invalidated and the behavior of methods
     * {@link Handle#decreaseKey(Object)} and {@link Handle#delete()} is
     * undefined.
     */
    void clear();

}