IntList

All Superinterfaces:

IntIterable, IntSizedIterable, java.lang.Iterable<IntIterator>

All Known Subinterfaces:

WritableIntList

All Known Implementing Classes:

AbstractIntList, AbstractIntList.SubList, AbstractIntListDecorator, AbstractIntListRemovingDecorator, AbstractWritableIntList, IntArray, IntCyclicQueue, IntList.Single, IntListConcatenation, IntListDiffIndexedDecorator, IntListInsertingDecorator, IntListRemovingDecorator, IntProgression, IntProgression.Arithmetic, IntSameValuesList, IntSegmentedArray, WritableIntListRemovingDecorator
```
public interface IntList
extends IntSizedIterable
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IntList.Single

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IntList.Single`

Field Summary

Fields
Modifier and Type Field and Description

static IntList EMPTY

Fields
Modifier and Type	Field and Description
`static IntList`	`EMPTY`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`binarySearch(int value)` Performs binary search.
`int`	`binarySearch(int value, int from, int to)` Performs binary search on list slice.
`boolean`	`contains(int value)` Checks whether collection contains specified value
`int`	`get(int index)`
`IntList`	`get(IntList indices)` Creates and returns a list which is this list indexed by `indices` Analogy: get(index) returns one value from this list, get(indices) returns a list with multiple values from this list.
`int`	`getNextDifferentValueIndex(int curIndex)` For a given index i, returns minimum index j, for which exactly one of the following holds: `j = -1 and for all k > i, a[k] = a[i]`; `j > i and a[i] != a[j]`, where `a` represents the list.
`int`	`indexOf(int value)`
`boolean`	`isEmpty()` Checks whether collection is empty.
`boolean`	`isSorted()`
`boolean`	`isSortedUnique()`
`IntListIterator`	`iterator()`
`IntListIterator`	`iterator(int from)`
`IntListIterator`	`iterator(int from, int to)`
`int`	`size()` Size of the collection.
`IntList`	`subList(int from, int to)` Returns a sub-list, backed by this list.
`java.util.List<java.lang.Integer>`	`toList()`
`int[]`	`toNativeArray()` Creates new native array and stores values there.
`int[]`	`toNativeArray(int startIndex, int[] dest, int destOffset, int length)` Writes values to dest.

- Field Detail
  - EMPTY
```
static final IntList EMPTY
```
- Method Detail
  - size
```
int size()
```
    Size of the collection. May not be efficient (up to O(N)).
    
    Specified by:
    
    size in interface IntSizedIterable
    
    Returns:
    the number of values in the collection
  - isEmpty
```
boolean isEmpty()
```
    Checks whether collection is empty. Must be efficient.
    
    Returns:
    true if there are no items in the collection.
  - contains
```
boolean contains(int value)
```
    Checks whether collection contains specified value
    
    Parameters:
    value - value to check
    
    Returns:
    true if collection contains value
  - get
```
int get(int index)
        throws java.util.NoSuchElementException
```
    Returns:
    the item at index. Valid value of an index is in range [0, size()). Note: May not be efficient (up to O(N)). Efficient algorithm should use iterator to iterate collection.
    
    Throws:
    
    java.util.NoSuchElementException
  - get
```
IntList get(IntList indices)
```
    Creates and returns a list which is this list indexed by indices
    Analogy: get(index) returns one value from this list, get(indices) returns a list with multiple values from this list. The values are
```
[get(indices.get(0)), get(indices.get(1)), .., get(indices.get(indices.size() - 1))]
```
    One of the possible usages is for MATLAB-like indexing, i.e. vector indexed by vector. Also IntIndexedIterator and IntListIndexedIterator can be used to iterate over this list via a custom set of indices.
    Returns:
    IntList with values located at indices in this list
    See Also:
    IntIndexedIterator, IntListIndexedIterator
  - indexOf
```
int indexOf(int value)
```
    Returns:
    index of first occurence of value. If not found returns negative value
  - toNativeArray
```
int[] toNativeArray()
```
    Creates new native array and stores values there.
    Note: effectively written code should avoid use this method.
  - toNativeArray
```
int[] toNativeArray(int startIndex,
                  int[] dest,
                  int destOffset,
                  int length)
```
    Writes values to dest.
    
    Returns:
    dest
  - subList
```
IntList subList(int from,
              int to)
```
    Returns a sub-list, backed by this list. If the list changes, changes will be reflected in the subList.
    NB: If values are removed from the parent list, this may result in OOBE when accessing sublist.
    
    Parameters:
    from - starting index, inclusive
    to - ending index, exclusive
  - binarySearch
```
int binarySearch(int value)
```
    Performs binary search. This method assumes that list is sorted. If not sorted the result is unpredictable.
    
    Returns:
    index of occurence or insertion point -index-1 if not found
  - binarySearch
```
int binarySearch(int value,
               int from,
               int to)
```
    Performs binary search on list slice. This method assumes that list slice is sorted. If not sorted the result is unpredictable.
    
    Returns:
    index of occurence or insertion point -index-1 if not found
  - isSorted
```
boolean isSorted()
```
    Returns:
    true if list is sorted in smallest first order
  - isSortedUnique
```
boolean isSortedUnique()
```
    Returns:
    true if list is sorted in smallest first order and all elements are unique
  - iterator
```
@NotNull
IntListIterator iterator()
```
    Specified by:
    
    iterator in interface IntIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<IntIterator>
    
    Returns:
    iterator initially located before first element. Iterator will walk the whole list
  - iterator
```
@NotNull
IntListIterator iterator(int from)
```
    Returns:
    iterator initially located before element at index from. Iterator will walk till last element
  - iterator
```
@NotNull
IntListIterator iterator(int from,
                               int to)
```
    Returns:
    iterator initially located before element at index from and iterator will walk up to index to (exclusive)
  - getNextDifferentValueIndex
```
int getNextDifferentValueIndex(int curIndex)
```
    For a given index i, returns minimum index j, for which exactly one of the following holds:
    - j = -1 and for all k > i, a[k] = a[i];
    - j > i and a[i] != a[j],
    where a represents the list.
    Returns:
    Index of the next different value or size() if all values starting from the specified index are the same.
  - toList
```
java.util.List<java.lang.Integer> toList()
```
    Returns:
    List filled with object wrappers

Interface IntList

Nested Class Summary

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

size

isEmpty

contains

get

get

indexOf

toNativeArray

toNativeArray

subList

binarySearch

binarySearch

isSorted

isSortedUnique

iterator

iterator

iterator

getNextDifferentValueIndex

toList