/*
* Copyright (C) 2003-2019 Paolo Boldi and Sebastiano Vigna
*
* 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 it.unimi.dsi.fastutil.shorts;
import java.util.NoSuchElementException;
import it.unimi.dsi.fastutil.PriorityQueue;
A type-specific PriorityQueue
; provides some additional methods that use polymorphism to avoid (un)boxing. Additionally, this interface strengthens comparator()
.
/**
* A type-specific {@link PriorityQueue}; provides some additional methods that
* use polymorphism to avoid (un)boxing.
*
* <p>
* Additionally, this interface strengthens {@link #comparator()}.
*/
public interface ShortPriorityQueue extends PriorityQueue<Short> {
Enqueues a new element.
Params: - x –
the element to enqueue.
See Also: - enqueue.enqueue(Object)
/**
* Enqueues a new element.
*
* @see PriorityQueue#enqueue(Object)
* @param x
* the element to enqueue.
*/
void enqueue(short x);
Dequeues the first element from the queue. Throws: - NoSuchElementException –
if the queue is empty.
See Also: Returns: the dequeued element.
/**
* Dequeues the {@linkplain #first() first} element from the queue.
*
* @see #dequeue()
* @return the dequeued element.
* @throws NoSuchElementException
* if the queue is empty.
*/
short dequeueShort();
Returns the first element of the queue.
Throws: - NoSuchElementException –
if the queue is empty.
See Also: - first()
Returns: the first element.
/**
* Returns the first element of the queue.
*
* @see #first()
* @return the first element.
* @throws NoSuchElementException
* if the queue is empty.
*/
short firstShort();
Returns the last element of the queue, that is, the element the would be
dequeued last (optional operation).
This default implementation just throws an UnsupportedOperationException
.
Throws: - NoSuchElementException –
if the queue is empty.
See Also: Returns: the last element.
/**
* Returns the last element of the queue, that is, the element the would be
* dequeued last (optional operation).
* <p>
* This default implementation just throws an
* {@link UnsupportedOperationException}.
*
* @see #last()
* @return the last element.
* @throws NoSuchElementException
* if the queue is empty.
*/
default short lastShort() {
throw new UnsupportedOperationException();
}
Returns the comparator associated with this priority queue, or null if it
uses its elements' natural ordering.
Note that this specification strengthens the one given in PriorityQueue.comparator()
.
See Also: Returns: the comparator associated with this priority queue.
/**
* Returns the comparator associated with this priority queue, or null if it
* uses its elements' natural ordering.
*
* <p>
* Note that this specification strengthens the one given in
* {@link PriorityQueue#comparator()}.
*
* @see PriorityQueue#comparator()
* @return the comparator associated with this priority queue.
*/
@Override
ShortComparator comparator();
{@inheritDoc}
This default implementation delegates to the corresponding type-specific
method.
Deprecated: Please use the corresponding type-specific method instead.
/**
* {@inheritDoc}
* <p>
* This default implementation delegates to the corresponding type-specific
* method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default void enqueue(final Short x) {
enqueue(x.shortValue());
}
{@inheritDoc}
This default implementation delegates to the corresponding type-specific
method.
Deprecated: Please use the corresponding type-specific method instead.
/**
* {@inheritDoc}
* <p>
* This default implementation delegates to the corresponding type-specific
* method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default Short dequeue() {
return Short.valueOf(dequeueShort());
}
{@inheritDoc}
This default implementation delegates to the corresponding type-specific
method.
Deprecated: Please use the corresponding type-specific method instead.
/**
* {@inheritDoc}
* <p>
* This default implementation delegates to the corresponding type-specific
* method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default Short first() {
return Short.valueOf(firstShort());
}
{@inheritDoc}
This default implementation delegates to the corresponding type-specific
method.
Deprecated: Please use the corresponding type-specific method instead.
/**
* {@inheritDoc}
* <p>
* This default implementation delegates to the corresponding type-specific
* method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default Short last() {
return Short.valueOf(lastShort());
}
}