/*
	* 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.floats;
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:
List/**
 * 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 FloatBigList extends BigList<Float>, FloatCollection, Size64, Comparable<BigList<? extends Float>> {
	
Returns a type-specific iterator on the elements of this list.
 Note that this specification strengthens the one given in Collection.iterator(). 
See Also:
Collection.iterator()/**
	 * 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
	FloatBigListIterator 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:
BigList.listIterator()/**
	 * 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
	FloatBigListIterator 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:
BigList.listIterator(long)/**
	 * 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
	FloatBigListIterator 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:
BigList.subList(long, long)/**
	 * 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
	FloatBigList 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, float 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, float 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, float a[][], long offset, long length);
	
Inserts the specified element at the specified position in this type-specific
big list (optional operation).
See Also:
add.add(long, Object)/**
	 * Inserts the specified element at the specified position in this type-specific
	 * big list (optional operation).
	 * 
	 * @see BigList#add(long,Object)
	 */
	void add(long index, float key);
	
Inserts all of the elements in the specified type-specific collection into
this type-specific big list at the specified position (optional operation).
See Also:
addAll.addAll(int, Collection)/**
	 * Inserts all of the elements in the specified type-specific collection into
	 * this type-specific big list at the specified position (optional operation).
	 * 
	 * @see List#addAll(int,java.util.Collection)
	 */
	boolean addAll(long index, FloatCollection c);
	
Inserts all of the elements in the specified type-specific big list into this
type-specific big list at the specified position (optional operation).
See Also:
addAll.addAll(int, Collection)/**
	 * Inserts all of the elements in the specified type-specific big list into this
	 * type-specific big list at the specified position (optional operation).
	 * 
	 * @see List#addAll(int,java.util.Collection)
	 */
	boolean addAll(long index, FloatBigList c);
	
Appends all of the elements in the specified type-specific big list to the
end of this type-specific big list (optional operation).
See Also:
addAll.addAll(int, Collection)/**
	 * Appends all of the elements in the specified type-specific big list to the
	 * end of this type-specific big list (optional operation).
	 * 
	 * @see List#addAll(int,java.util.Collection)
	 */
	boolean addAll(FloatBigList c);
	
Returns the element at the specified position.
See Also:
get.get(long)/**
	 * Returns the element at the specified position.
	 * 
	 * @see BigList#get(long)
	 */
	float getFloat(long index);
	
Removes the element at the specified position.
See Also:
remove.remove(long)/**
	 * Removes the element at the specified position.
	 * 
	 * @see BigList#remove(long)
	 */
	float removeFloat(long index);
	
Replaces the element at the specified position in this big list with the
specified element (optional operation).
See Also:
set.set(long, Object)/**
	 * Replaces the element at the specified position in this big list with the
	 * specified element (optional operation).
	 * 
	 * @see BigList#set(long,Object)
	 */
	float set(long index, float k);
	
Returns the index of the first occurrence of the specified element in this
type-specific big list, or -1 if this big list does not contain the element.
See Also:
indexOf.indexOf(Object)/**
	 * Returns the index of the first occurrence of the specified element in this
	 * type-specific big list, or -1 if this big list does not contain the element.
	 * 
	 * @see BigList#indexOf(Object)
	 */
	long indexOf(float k);
	
Returns the index of the last occurrence of the specified element in this
type-specific big list, or -1 if this big list does not contain the element.
See Also:
lastIndexOf.lastIndexOf(Object)/**
	 * Returns the index of the last occurrence of the specified element in this
	 * type-specific big list, or -1 if this big list does not contain the element.
	 * 
	 * @see BigList#lastIndexOf(Object)
	 */
	long lastIndexOf(float k);
	
{@inheritDoc}
Deprecated:
Please use the corresponding type-specific method instead./**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	void add(long index, Float key);
	
{@inheritDoc}
Deprecated:
Please use the corresponding type-specific method instead./**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	Float get(long index);
	
{@inheritDoc}
Deprecated:
Please use the corresponding type-specific method instead./**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	long indexOf(Object o);
	
{@inheritDoc}
Deprecated:
Please use the corresponding type-specific method instead./**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	long lastIndexOf(Object o);
	
{@inheritDoc}
Deprecated:
Please use the corresponding type-specific method instead./**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	Float remove(long index);
	
{@inheritDoc}
Deprecated:
Please use the corresponding type-specific method instead./**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	Float set(long index, Float k);
}