Package processing.data

Class IntList

java.lang.Object
processing.data.IntList
All Implemented Interfaces:
Iterable<Integer>
public class IntList extends Object implements Iterable<Integer>
Helper class for a list of int values. Lists are designed to have some features of ArrayList, but to maintain the simplicity and efficiency of working with arrays. Functions such as sort() and shuffle() always act on the list itself. To get a sorted copy, use list.copy().sort().
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntList()
     
    IntList(int length)
     
    IntList(int[] source)
     
    IntList(Iterable<Object> iterable)
    Construct an IntList from an iterable pile of objects.
    IntList(Object... items)
    Construct an IntList from a random pile of objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(int index, int amount)
    Add to a value.
    void
    append(int value)
    Add a new entry to the list.
    void
    append(int[] values)
     
    void
    append(IntList list)
     
    void
    appendUnique(int value)
    Add this value, but only if it's not already in the list.
    int[]
    array()
    Deprecated.
    int[]
    array(int[] array)
    Deprecated.
    int
    choice()
    Return a random value from the list.
    void
    clear()
    Remove all entries from the list.
    IntList
    copy()
     
    void
    div(int index, int amount)
    Divide a value.
    static IntList
    fromRange(int stop)
     
    static IntList
    fromRange(int start, int stop)
     
    int
    get(int index)
    Get an entry at a particular index.
    FloatList
    getPercent()
    Returns a normalized version of this array.
    IntList
    getSubset(int start)
     
    IntList
    getSubset(int start, int num)
     
    boolean
    hasValue(int value)
    Check if a number is a part of the data structure.
    void
    increment(int index)
    Add one to a value.
    int
    index(int what)
    Return the first index of a particular value.
    void
    insert(int index, int value)
     
    void
    insert(int index, int[] values)
     
    void
    insert(int index, IntList list)
     
    Iterator<Integer>
    iterator()
     
    String
    join(String separator)
     
    int
    max()
    Return the largest value.
    int
    maxIndex()
     
    int
    min()
    Return the smallest value.
    int
    minIndex()
     
    void
    mult(int index, int amount)
    Multiply a value.
    int
    pop()
     
    void
    print()
     
    void
    push(int value)
    Just an alias for append(), but matches pop()
    int
    remove(int index)
    Remove an element from the specified index
    int
    removeChoice()
     
    int
    removeValue(int value)
     
    int
    removeValues(int value)
     
    void
    resize(int length)
     
    void
    reverse()
    Reverse the order of the list.
    void
    save(File file)
    Save tab-delimited entries to a file (TSV format, UTF-8 encoding)
    void
    set(int index, int what)
    Set the entry at a particular index.
    void
    shuffle()
    Randomize the order of the list elements.
    void
    shuffle(PApplet sketch)
    Randomize the list order using the random() function from the specified sketch, allowing shuffle() to use its current randomSeed() setting.
    int
    size()
    Get the length of the list.
    void
    sort()
    Sorts the array, lowest to highest.
    void
    sortReverse()
    A sort in reverse.
    void
    sub(int index, int amount)
    Subtract from a value.
    int
    sum()
     
    long
    sumLong()
     
    int[]
    toArray()
    Create a new array with a copy of all the values.
    int[]
    toArray(int[] array)
    Copy values into the specified array.
    String
    toJSON()
    Return this dictionary as a String in JSON format.
    String
    toString()
     
    int[]
    values()
    Returns the actual array being used to store the data.
    void
    write(PrintWriter writer)
    Write entries to a PrintWriter, one per line

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Constructor Details

    • IntList

      public IntList()

    • IntList

      public IntList(int length)

    • IntList

      public IntList(int[] source)

    • IntList

      public IntList(Iterable<Object> iterable)
      Construct an IntList from an iterable pile of objects. For instance, a float array, an array of strings, who knows. Un-parsable or null values will be set to 0.

    • IntList

      public IntList(Object... items)
      Construct an IntList from a random pile of objects. Un-parsable or null values will be set to zero.

  • Method Details

    • fromRange

      public static IntList fromRange(int stop)

    • fromRange

      public static IntList fromRange(int start, int stop)

    • size

      public int size()
      Get the length of the list.

    • resize

      public void resize(int length)

    • clear

      public void clear()
      Remove all entries from the list.

    • get

      public int get(int index)
      Get an entry at a particular index.

    • set

      public void set(int index, int what)
      Set the entry at a particular index.

    • push

      public void push(int value)
      Just an alias for append(), but matches pop()

    • pop

      public int pop()

    • remove

      public int remove(int index)
      Remove an element from the specified index

    • removeValue

      public int removeValue(int value)

    • removeValues

      public int removeValues(int value)

    • append

      public void append(int value)
      Add a new entry to the list.

    • append

      public void append(int[] values)

    • append

      public void append(IntList list)

    • appendUnique

      public void appendUnique(int value)
      Add this value, but only if it's not already in the list.

    • insert

      public void insert(int index, int value)

    • insert

      public void insert(int index, int[] values)

    • insert

      public void insert(int index, IntList list)

    • index

      public int index(int what)
      Return the first index of a particular value.

    • hasValue

      public boolean hasValue(int value)
      Check if a number is a part of the data structure.

    • increment

      public void increment(int index)
      Add one to a value.

    • add

      public void add(int index, int amount)
      Add to a value.

    • sub

      public void sub(int index, int amount)
      Subtract from a value.

    • mult

      public void mult(int index, int amount)
      Multiply a value.

    • div

      public void div(int index, int amount)
      Divide a value.

    • min

      public int min()
      Return the smallest value.

    • minIndex

      public int minIndex()

    • max

      public int max()
      Return the largest value.

    • maxIndex

      public int maxIndex()

    • sum

      public int sum()

    • sumLong

      public long sumLong()

    • sort

      public void sort()
      Sorts the array, lowest to highest.

    • sortReverse

      public void sortReverse()
      A sort in reverse. It's equivalent to running sort() and then reverse(), but is more efficient than running each separately.

    • reverse

      public void reverse()
      Reverse the order of the list.

    • shuffle

      public void shuffle()
      Randomize the order of the list elements.

    • shuffle

      public void shuffle(PApplet sketch)
      Randomize the list order using the random() function from the specified sketch, allowing shuffle() to use its current randomSeed() setting.

    • choice

      public int choice()
      Return a random value from the list.

    • removeChoice

      public int removeChoice()

    • copy

      public IntList copy()

    • values

      public int[] values()
      Returns the actual array being used to store the data. For advanced users, this is the fastest way to access a large list. Suitable for iterating with a for() loop, but modifying the list will have terrible consequences.

    • iterator

      public Iterator<Integer> iterator()
      Specified by:
      iterator in interface Iterable<Integer>

    • array

      @Deprecated public int[] array()
      Deprecated.

    • toArray

      public int[] toArray()
      Create a new array with a copy of all the values.
      Returns:
      an array sized by the length of the list with each of the values.

    • array

      @Deprecated public int[] array(int[] array)
      Deprecated.

    • toArray

      public int[] toArray(int[] array)
      Copy values into the specified array. If the specified array is null or not the same size, a new array will be allocated.

    • getPercent

      public FloatList getPercent()
      Returns a normalized version of this array. Called getPercent() for consistency with the Dict classes. It's a getter method because it needs to return a new list (because IntList/Dict can't do percentages or normalization in place on int values).

    • getSubset

      public IntList getSubset(int start)

    • getSubset

      public IntList getSubset(int start, int num)

    • join

      public String join(String separator)

    • print

      public void print()

    • save

      public void save(File file)
      Save tab-delimited entries to a file (TSV format, UTF-8 encoding)

    • write

      public void write(PrintWriter writer)
      Write entries to a PrintWriter, one per line

    • toJSON

      public String toJSON()
      Return this dictionary as a String in JSON format.

    • toString

      public String toString()
      Overrides:
      toString in class Object