package it.unimi.dsi.fastutil;
/*
* Copyright (C) 2010-2019 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.
*/
import java.util.Collection;
import java.util.List;
A list with big (i.e., 64-bit) indices.
Instances of this class implement the same semantics as that of List
: however, getters and setters use long indices, search methods return long values, and iterators are of type BigListIterator
.
/** A list with big (i.e., 64-bit) indices.
*
* <p>Instances of this class implement the same semantics as that of {@link List}: however,
* getters and setters use long indices, search methods return long values,
* and iterators are of type {@link BigListIterator}.
*/
public interface BigList<K> extends Collection<K>, Size64 {
Returns the element at the specified position.
Params: - index – a position in the big list.
See Also: Returns: the element at the specified position.
/** Returns the element at the specified position.
*
* @param index a position in the big list.
* @return the element at the specified position.
* @see List#get(int)
*/
K get(long index);
Removes the element at the specified position.
Params: - index – a position in the big list.
See Also: Returns: the element previously at the specified position.
/** Removes the element at the specified position.
*
* @param index a position in the big list.
* @return the element previously at the specified position.
* @see List#remove(int)
*/
K remove(long index);
Replaces the element at the specified position in this big list with the specified element (optional operation).
Params: - index – a position in the big list.
- element – the element to be stored at the specified position.
See Also: Returns: the element previously at the specified positions.
/** Replaces the element at the specified position in this big list with the specified element (optional operation).
*
* @param index a position in the big list.
* @param element the element to be stored at the specified position.
* @return the element previously at the specified positions.
* @see List#set(int,Object)
*/
K set(long index, K element);
Inserts the specified element at the specified position in this big list (optional operation).
Params: - index – a position in the big list.
- element – an element to be inserted.
See Also:
/** Inserts the specified element at the specified position in this big list (optional operation).
*
* @param index a position in the big list.
* @param element an element to be inserted.
* @see List#add(int,Object)
*/
void add(long index, K element);
Sets the size of this big list.
If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null
/false
.
Params: - size – the new size.
/** Sets the size of this big list.
*
* <p>If the specified size is smaller than the current size, the last elements are
* discarded. Otherwise, they are filled with 0/{@code null}/{@code false}.
*
* @param size the new size.
*/
void size(long size);
Inserts all of the elements in the specified collection into this big list at the specified position (optional operation).
Params: - index – index at which to insert the first element from the specified collection.
- c – collection containing elements to be added to this big list.
See Also: Returns: true
if this big list changed as a result of the call
/** Inserts all of the elements in the specified collection into this big list at the specified position (optional operation).
*
* @param index index at which to insert the first element from the specified collection.
* @param c collection containing elements to be added to this big list.
* @return {@code true} if this big list changed as a result of the call
* @see List#addAll(int, Collection)
*/
boolean addAll(long index, Collection<? extends K> c);
Returns the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
Params: - o – the object to search for.
See Also: Returns: the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
/** Returns the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
*
* @param o the object to search for.
* @return the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
* @see List#indexOf(Object)
*/
long indexOf(Object o);
Returns the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
Params: - o – the object to search for.
See Also: Returns: the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
/** Returns the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
*
* @param o the object to search for.
* @return the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
* @see List#lastIndexOf(Object)
*/
long lastIndexOf(Object o);
Returns a big-list iterator over the elements in this big list.
See Also: Returns: a big-list iterator over the elements in this big list.
/** Returns a big-list iterator over the elements in this big list.
*
* @return a big-list iterator over the elements in this big list.
* @see List#listIterator()
*/
BigListIterator<K> listIterator();
Returns a big-list iterator of the elements in this big list, starting at the specified position in this big list.
Params: - index – index of first element to be returned from the big-list iterator.
See Also: Returns: a big-list iterator of the elements in this big list, starting at the specified position in
this big list.
/** Returns a big-list iterator of the elements in this big list, starting at the specified position in this big list.
*
* @param index index of first element to be returned from the big-list iterator.
* @return a big-list iterator of the elements in this big list, starting at the specified position in
* this big list.
* @see List#listIterator(int)
*/
BigListIterator<K> listIterator(long index);
Returns a big sublist view of this big list.
Params: - from – the starting element (inclusive).
- to – the ending element (exclusive).
See Also: Returns: a big sublist view of this big list.
/** Returns a big sublist view of this big list.
*
* @param from the starting element (inclusive).
* @param to the ending element (exclusive).
* @return a big sublist view of this big list.
* @see List#subList(int, int)
*/
BigList<K> subList(long from, long to);
{@inheritDoc}
Deprecated: Use Size64.size64()
instead.
/** {@inheritDoc}
* @deprecated Use {@link #size64()} instead. */
@Override
@Deprecated
default int size() {
return Size64.super.size();
}
}