/*
* 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.
*/
package it.unimi.dsi.fastutil.objects;
import java.util.List;
import it.unimi.dsi.fastutil.BigList;
import it.unimi.dsi.fastutil.Size64;
A type-specific BigList
; provides some additional methods that use polymorphism to avoid (un)boxing. Additionally, this interface strengthens iterator()
, listIterator()
, listIterator(long)
and subList(long, long)
.
Besides polymorphic methods, this interfaces specifies methods to copy into
an array or remove contiguous sublists. Although the abstract implementation
of this interface provides simple, one-by-one implementations of these
methods, it is expected that concrete implementation override them with
optimized versions.
See Also:
/**
* A type-specific {@link BigList}; provides some additional methods that use
* polymorphism to avoid (un)boxing.
*
* <p>
* Additionally, this interface strengthens {@link #iterator()},
* {@link #listIterator()}, {@link #listIterator(long)} and
* {@link #subList(long,long)}.
*
* <p>
* Besides polymorphic methods, this interfaces specifies methods to copy into
* an array or remove contiguous sublists. Although the abstract implementation
* of this interface provides simple, one-by-one implementations of these
* methods, it is expected that concrete implementation override them with
* optimized versions.
*
* @see List
*/
public interface ObjectBigList<K> extends BigList<K>, ObjectCollection<K>, Size64, Comparable<BigList<? extends K>> {
Returns a type-specific iterator on the elements of this list.
Note that this specification strengthens the one given in Collection.iterator()
.
See Also:
/**
* Returns a type-specific iterator on the elements of this list.
*
* <p>
* Note that this specification strengthens the one given in
* {@link java.util.Collection#iterator()}.
*
* @see java.util.Collection#iterator()
*/
@Override
ObjectBigListIterator<K> iterator();
Returns a type-specific big-list iterator on this type-specific big list.
Note that this specification strengthens the one given in BigList.listIterator()
.
See Also:
/**
* Returns a type-specific big-list iterator on this type-specific big list.
*
* <p>
* Note that this specification strengthens the one given in
* {@link BigList#listIterator()}.
*
* @see BigList#listIterator()
*/
@Override
ObjectBigListIterator<K> listIterator();
Returns a type-specific list iterator on this type-specific big list starting
at a given index.
Note that this specification strengthens the one given in BigList.listIterator(long)
.
See Also:
/**
* Returns a type-specific list iterator on this type-specific big list starting
* at a given index.
*
* <p>
* Note that this specification strengthens the one given in
* {@link BigList#listIterator(long)}.
*
* @see BigList#listIterator(long)
*/
@Override
ObjectBigListIterator<K> listIterator(long index);
Returns a type-specific view of the portion of this type-specific big list from the index from
, inclusive, to the index to
, exclusive. Note that this specification strengthens the one given in BigList.subList(long, long)
.
See Also:
/**
* Returns a type-specific view of the portion of this type-specific big list
* from the index {@code from}, inclusive, to the index {@code to}, exclusive.
*
* <p>
* Note that this specification strengthens the one given in
* {@link BigList#subList(long,long)}.
*
* @see BigList#subList(long,long)
*/
@Override
ObjectBigList<K> subList(long from, long to);
Copies (hopefully quickly) elements of this type-specific big list into the
given big array.
Params: - from –
the start index (inclusive).
- a –
the destination big array.
- offset –
the offset into the destination big array where to store the first
element copied.
- length –
the number of elements to be copied.
/**
* Copies (hopefully quickly) elements of this type-specific big list into the
* given big array.
*
* @param from
* the start index (inclusive).
* @param a
* the destination big array.
* @param offset
* the offset into the destination big array where to store the first
* element copied.
* @param length
* the number of elements to be copied.
*/
void getElements(long from, Object a[][], long offset, long length);
Removes (hopefully quickly) elements of this type-specific big list.
Params: - from –
the start index (inclusive).
- to –
the end index (exclusive).
/**
* Removes (hopefully quickly) elements of this type-specific big list.
*
* @param from
* the start index (inclusive).
* @param to
* the end index (exclusive).
*/
void removeElements(long from, long to);
Add (hopefully quickly) elements to this type-specific big list.
Params: - index –
the index at which to add elements.
- a –
the big array containing the elements.
/**
* Add (hopefully quickly) elements to this type-specific big list.
*
* @param index
* the index at which to add elements.
* @param a
* the big array containing the elements.
*/
void addElements(long index, K a[][]);
Add (hopefully quickly) elements to this type-specific big list.
Params: - index –
the index at which to add elements.
- a –
the big array containing the elements.
- offset –
the offset of the first element to add.
- length –
the number of elements to add.
/**
* Add (hopefully quickly) elements to this type-specific big list.
*
* @param index
* the index at which to add elements.
* @param a
* the big array containing the elements.
* @param offset
* the offset of the first element to add.
* @param length
* the number of elements to add.
*/
void addElements(long index, K a[][], long offset, long length);
}