it.unimi.dsi.fastutil.floats

Interface FloatList

All Superinterfaces:

Collection<Float>, Comparable<List<? extends Float>>, FloatCollection, FloatIterable, Iterable<Float>, List<Float>

All Known Implementing Classes:

AbstractFloatList, AbstractFloatList.FloatSubList, FloatArrayList, FloatLists.EmptyList, FloatLists.Singleton, FloatLists.SynchronizedList, FloatLists.SynchronizedRandomAccessList, FloatLists.UnmodifiableList, FloatLists.UnmodifiableRandomAccessList

public interface FloatList
extends List<Float>, Comparable<List<? extends Float>>, FloatCollection

A type-specific List; provides some additional methods that use polymorphism to avoid (un)boxing.

Note that this type-specific interface extends Comparable: it is expected that implementing classes perform a lexicographical comparison using the standard operator "less then" for primitive types, and the usual compareTo() method for objects.

Additionally, this interface strengthens listIterator(), listIterator(int) and subList(int,int).

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

Method Summary

Modifier and Type	Method and Description
boolean	add(float key) Appends the specified element to the end of this list (optional operation).
default boolean	add(Float k) Deprecated. Please use the corresponding type-specific method instead.
void	add(int index, float key) Inserts the specified element at the specified position in this list (optional operation).
default void	add(int index, Float key) Deprecated. Please use the corresponding type-specific method instead.
boolean	addAll(FloatList c) Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
boolean	addAll(int index, FloatCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).
boolean	addAll(int index, FloatList c) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
void	addElements(int index, float[] a) Add (hopefully quickly) elements to this type-specific list.
void	addElements(int index, float[] a, int offset, int length) Add (hopefully quickly) elements to this type-specific list.
default boolean	contains(Object key) Deprecated. Please use the corresponding type-specific method instead.
default Float	get(int index) Deprecated. Please use the corresponding type-specific method instead.
void	getElements(int from, float[] a, int offset, int length) Copies (hopefully quickly) elements of this type-specific list into the given array.
float	getFloat(int index) Returns the element at the specified position in this list.
int	indexOf(float k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
default int	indexOf(Object o) Deprecated. Please use the corresponding type-specific method instead.
FloatListIterator	iterator() Returns a type-specific iterator on the elements of this list.
int	lastIndexOf(float k) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
default int	lastIndexOf(Object o) Deprecated. Please use the corresponding type-specific method instead.
FloatListIterator	listIterator() Returns a type-specific list iterator on the list.
FloatListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
default Float	remove(int index) Deprecated. Please use the corresponding type-specific method instead.
default boolean	remove(Object key) Deprecated. Please use the corresponding type-specific method instead.
void	removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.
float	removeFloat(int index) Removes the element at the specified position in this list (optional operation).
float	set(int index, float k) Replaces the element at the specified position in this list with the specified element (optional operation).
default Float	set(int index, Float k) Deprecated. Please use the corresponding type-specific method instead.
default void	setElements(float[] a) Set (hopefully quickly) elements to match the array given.
default void	setElements(int index, float[] a) Set (hopefully quickly) elements to match the array given.
default void	setElements(int index, float[] a, int offset, int length) Set (hopefully quickly) elements to match the array given.
void	size(int size) Sets the size of this list.
default void	sort(Comparator<? super Float> comparator) Deprecated. Please use the corresponding type-specific method instead.
default void	sort(FloatComparator comparator) Sort a list using a type-specific comparator.
FloatList	subList(int from, int to) Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
default void	unstableSort(Comparator<? super Float> comparator) Deprecated. Please use the corresponding type-specific method instead.
default void	unstableSort(FloatComparator comparator) Sorts this list using a sort not assured to be stable.

Methods inherited from interface java.util.List

addAll, addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, replaceAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatCollection

addAll, contains, containsAll, rem, removeAll, removeIf, removeIf, retainAll, toArray, toFloatArray, toFloatArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatIterable

forEach, forEach

Method Detail

iterator

FloatListIterator iterator()

Returns a type-specific iterator on the elements of this list.

Note that this specification strengthens the one given in List.iterator(). It would not be normally necessary, but Iterable.iterator() is bizarrily re-specified in List.

Specified by:

iterator in interface Collection<Float>

Specified by:

iterator in interface FloatCollection

Specified by:

iterator in interface FloatIterable

Specified by:

iterator in interface Iterable<Float>

Specified by:

iterator in interface List<Float>

Returns:

an iterator on the elements of this list.

See Also:

Iterable.iterator()

listIterator

FloatListIterator listIterator()

Returns a type-specific list iterator on the list.

Specified by:

listIterator in interface List<Float>

See Also:

List.listIterator()

listIterator

FloatListIterator listIterator(int index)

Returns a type-specific list iterator on the list starting at a given index.

Specified by:

listIterator in interface List<Float>

See Also:

List.listIterator(int)

subList

FloatList subList(int from,
                  int to)

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Note that this specification strengthens the one given in List.subList(int,int).

Specified by:

subList in interface List<Float>

See Also:

List.subList(int,int)

size

void size(int size)

Sets the size of this list.

If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.

Parameters:

size - the new size.

getElements

void getElements(int from,
                 float[] a,
                 int offset,
                 int length)

Copies (hopefully quickly) elements of this type-specific list into the given array.

Parameters:

from - the start index (inclusive).

a - the destination array.

offset - the offset into the destination array where to store the first element copied.

length - the number of elements to be copied.

removeElements

void removeElements(int from,
                    int to)

Removes (hopefully quickly) elements of this type-specific list.

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

void addElements(int index,
                 float[] a)

Add (hopefully quickly) elements to this type-specific list.

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

addElements

void addElements(int index,
                 float[] a,
                 int offset,
                 int length)

Add (hopefully quickly) elements to this type-specific list.

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

offset - the offset of the first element to add.

length - the number of elements to add.

setElements

default void setElements(float[] a)

Set (hopefully quickly) elements to match the array given.

Parameters:

a - the array containing the elements.

Since:

8.3.0

setElements

default void setElements(int index,
                         float[] a)

Set (hopefully quickly) elements to match the array given.

Parameters:

index - the index at which to start setting elements.

a - the array containing the elements.

Since:

8.3.0

setElements

default void setElements(int index,
                         float[] a,
                         int offset,
                         int length)

Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by

 ListIterator iter = listIterator(index);
 int i = 0;
 while (i < length) {
   iter.next();
   iter.set(a[offset + i++]);
 }
 

However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.

Parameters:

index - the index at which to start setting elements.

a - the array containing the elements

offset - the offset of the first element to add.

length - the number of elements to add.

Since:

8.3.0

add

boolean add(float key)

Appends the specified element to the end of this list (optional operation).

Specified by:

add in interface FloatCollection

See Also:

List.add(Object)

add

void add(int index,
         float key)

Inserts the specified element at the specified position in this list (optional operation).

See Also:

List.add(int,Object)

add

@Deprecated
default void add(int index,
                             Float key)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

add in interface List<Float>

addAll

boolean addAll(int index,
               FloatCollection c)

Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).

See Also:

List.addAll(int,java.util.Collection)

addAll

boolean addAll(int index,
               FloatList c)

Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).

See Also:

List.add(int,Object)

addAll

boolean addAll(FloatList c)

Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).

See Also:

List.add(int,Object)

set

float set(int index,
          float k)

Replaces the element at the specified position in this list with the specified element (optional operation).

See Also:

List.set(int,Object)

getFloat

float getFloat(int index)

Returns the element at the specified position in this list.

See Also:

List.get(int)

indexOf

int indexOf(float k)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

See Also:

List.indexOf(Object)

lastIndexOf

int lastIndexOf(float k)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

See Also:

List.lastIndexOf(Object)

contains

@Deprecated
default boolean contains(Object key)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

contains in interface Collection<Float>

Specified by:

contains in interface FloatCollection

Specified by:

contains in interface List<Float>

get

@Deprecated
default Float get(int index)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

get in interface List<Float>

indexOf

@Deprecated
default int indexOf(Object o)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

indexOf in interface List<Float>

lastIndexOf

@Deprecated
default int lastIndexOf(Object o)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

lastIndexOf in interface List<Float>

add

@Deprecated
default boolean add(Float k)

Deprecated. Please use the corresponding type-specific method instead.

This method specification is a workaround for bug 8177440.

Specified by:

add in interface Collection<Float>

Specified by:

add in interface FloatCollection

Specified by:

add in interface List<Float>

removeFloat

float removeFloat(int index)

Removes the element at the specified position in this list (optional operation).

See Also:

List.remove(int)

remove

@Deprecated
default boolean remove(Object key)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

remove in interface Collection<Float>

Specified by:

remove in interface FloatCollection

Specified by:

remove in interface List<Float>

remove

@Deprecated
default Float remove(int index)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

remove in interface List<Float>

set

@Deprecated
default Float set(int index,
                              Float k)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

set in interface List<Float>

sort

@Deprecated
default void sort(Comparator<? super Float> comparator)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

sort in interface List<Float>

sort

default void sort(FloatComparator comparator)

Sort a list using a type-specific comparator.

Pass null to sort using natural ordering.

Since:

8.3.0

See Also:

List.sort(java.util.Comparator)

unstableSort

@Deprecated
default void unstableSort(Comparator<? super Float> comparator)

Deprecated. Please use the corresponding type-specific method instead.

Sorts this list using a sort not assured to be stable.

unstableSort

default void unstableSort(FloatComparator comparator)

Sorts this list using a sort not assured to be stable.

Pass null to sort using natural ordering.

This differs from List.sort(java.util.Comparator) in that the results are not assured to be stable, but may be a bit faster.

Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.

Since:

8.3.0