IntArray (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.ArrayBase
- - org.xmlcml.euclid.IntArray

All Implemented Interfaces:

Iterable<Integer>, EuclidConstants
```
public class IntArray
extends ArrayBase
implements Iterable<Integer>
```
array of ints IntArray represents a 1-dimensional vector or array of ints and is basically a wrapper for int[] in Java There are a lot of useful member functions (sorting, ranges, parallel operations The default is an array with zero points All arrays are valid objects. Attempting to create an array with < 0 points creates a default array (zero points). Since int[] knows its length (unlike C), there are many cases where int[] can be safely used. However it is not a first-class object and IntArray supplies this feature int[] is referenceable through getArray() note that the length of the internal array may not be a useful guide to the number of elements

Author:

(C) P. Murray-Rust, 1996

Nested Class Summary
- Nested classes/interfaces inherited from class org.xmlcml.euclid.ArrayBase
  ArrayBase.Trim

Field Summary
- Fields inherited from class org.xmlcml.euclid.ArrayBase
  ARRAY_REGEX
- Fields inherited from interface org.xmlcml.euclid.EuclidConstants
  C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Constructor Summary

Constructors
Constructor and Description
`IntArray()` create default Array.
`IntArray(int n)` creates n-element array.
`IntArray(int[] arr)` create Array from java array.
`IntArray(IntArray m)` copy constructor.
`IntArray(IntArray ref, IntArray sub)` create mixed sliced array.
`IntArray(IntArray m, int low, int high)` create from subarray of another Array.
`IntArray(int n, int elem1)` create Array initialized to constant value.
`IntArray(int n, int[] arr)` create Array from part of java array.
`IntArray(int n, int elem1, int delta)` create n-element array initialised linearly.
`IntArray(int nn, String shape, int maxval)` Create customized array.
`IntArray(List<Integer> intList)`
`IntArray(String string)` create from a space-separated string of integers.
`IntArray(String[] strings)` construct from an array of Strings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`absSumAllElements()` sum of all absolute element values.
`void`	`addArray(IntArray f)` append elements.
`void`	`addElement(int f)` append element.
`IntArray`	`applyFilter(IntArray filter)` apply filter.
`void`	`clearArray()` clear all elements of array.
`Object`	`clone()` clone.
`void`	`contractArray()` contracts internal array to be of same length as number of elements.
`Set<Integer>`	`createIntegerSet()`
`IntArray`	`cumulativeSum()` cumulative sum of array.
`void`	`decrementElementAt(int i)`
`void`	`deleteElement(int elem)` delete element and close up.
`void`	`deleteElements(int low, int high)` delete elements and close up.
`int`	`dotProduct(IntArray f)` dot product of two arrays.
`int`	`elementAt(int elem)` get element by index.
`boolean`	`equals(IntArray f)` are two arrays equal.
`boolean`	`equals(Object obj)`
`int[]`	`getArray()` get java array.
`Integer`	`getConstant()` if all values are equal returns value else null
`int`	`getMax()` value of largest element.
`int`	`getMin()` value of smallest element.
`IntRange`	`getRange()` range of array.
`IntArray`	`getReorderedArray(IntSet idx)` get reordered Array.
`int[]`	`getReverseArray()` get java array in reverse order.
`String[]`	`getStringValues()` returns values as strings.
`IntArray`	`getSubArray(int start, int end)` get array slice.
`int`	`hashCode()`
`void`	`incrementElementAt(int i)`
`int`	`indexOfLargestElement()` index of largest element.
`int`	`indexOfSmallestElement()` index of smallest element.
`IntSet`	`indexSortAscending()` get indexes of ascending sorted array.
`IntSet`	`indexSortDescending()` get indexes of descending sorted array.
`int`	`innerProduct()` inner product.
`IntSet`	`inRange(IntRange r)` get elements within a range.
`void`	`insertArray(int elem, IntArray f)` insert an array and expand.
`void`	`insertElementAt(int elem, int f)` insert element and expand.
`boolean`	`isArithmeticProgression(int delta)` returns true if array is of form: i, i+delta, i+2*delta ...
`boolean`	`isClear()` is the array filled with zeros.
`boolean`	`isEqualTo(IntArray f)` are two arrays equal.
`static boolean`	`isIntArray(String s, String delimiterRegex)` parse string as integerArray.
`Iterator<Integer>`	`iterator()`
`int`	`largestElement()` value of largest element.
`IntArray`	`multiplyBy(int f)` array multiplication by a scalar.
`void`	`negative()` change the sign of all elements.
`IntSet`	`outOfRange(IntRange r)` get elements outside a range.
`IntArray`	`plus(IntArray f)` adds arrays.
`void`	`reverse()` puts array into reverse order.
`void`	`setAllElements(int f)` initialise array to given value.
`void`	`setElementAt(int elem, int f)` set element value.
`void`	`setElements(int start, int[] a)` set array slice.
`void`	`shallowCopy(IntArray m)` shallowCopy
`int`	`size()` get actual number of elements.
`int`	`smallestElement()` value of smallest element.
`void`	`sortAscending()` sorts array into ascending order.
`void`	`sortDescending()` sorts array into descending order.
`IntArray`	`subtract(IntArray f)` subtracts arrays.
`void`	`subtractEquals(IntArray f)` array subtraction.
`int`	`sumAllElements()` sum all elements.
`String`	`toString()` gets values as string.
`IntArray`	`trim(ArrayBase.Trim flag, int limit)` trims array to lie within limit.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - IntArray
```
public IntArray()
```
    create default Array. default is an array of zero points
  - IntArray
```
public IntArray(int n)
```
    creates n-element array. initialised to 0
    
    Parameters:
    
    n - size of array
  - IntArray
```
public IntArray(int n,
                int elem1,
                int delta)
```
    create n-element array initialised linearly. values are elem1+(i-1)*delta
    
    Parameters:
    
    n - size of array
    
    elem1 - starting value
    
    delta - setpsize
  - IntArray
```
public IntArray(int n,
                int elem1)
```
    create Array initialized to constant value. all elements of the array are set to a given value
    
    Parameters:
    
    n - size of array
    
    elem1 - value to set
  - IntArray
```
public IntArray(int n,
                int[] arr)
         throws EuclidRuntimeException
```
    create Array from part of java array. use first n elements of array.
    
    Parameters:
    
    n - number of elements to use
    
    arr - array to read from
    
    Throws:
    
    EuclidRuntimeException - n larger than arraysize
  - IntArray
```
public IntArray(int[] arr)
```
    create Array from java array.
    
    Parameters:
    
    arr - array to read from
  - IntArray
```
public IntArray(List<Integer> intList)
```
  - IntArray
```
public IntArray(IntArray m,
                int low,
                int high)
         throws EuclidRuntimeException
```
    create from subarray of another Array.
    
    Parameters:
    
    m - array to slice
    
    low - inclusive start index of array
    
    high - inclusive end index of array
    
    Throws:
    
    EuclidRuntimeException - low > high or negative indices or outside size of m
  - IntArray
```
public IntArray(IntArray ref,
                IntArray sub)
         throws EuclidRuntimeException
```
    create mixed sliced array. use another IntArray to subscript this one where I(this) = I(ref) subscripted by I(sub); Result has dimension of I(sub). caller is responsible for making sure elements of sub are unique
    
    Parameters:
    
    ref - matrix to slice
    
    sub - subscripts.
    
    Throws:
    
    EuclidRuntimeException - if any of I(sub) lies outside 0...refmax-1
  - IntArray
```
public IntArray(IntArray m)
```
    copy constructor.
    
    Parameters:
    
    m - array to copy
  - IntArray
```
public IntArray(int nn,
                String shape,
                int maxval)
```
    Create customized array. create a given 'shape' of array for data filtering An intended use is with IntArray.arrayFilter(). The shapes (before scaling by maxval) are:
    - "TRIANGLE"; 1/nn, 2/nn, ... 1 ... 2/nn, 1/nn; nelem is set to 2*nn - 1
    - "ZIGZAG"; 1/nn, 2/nn, ... 1 ... 1/nn, 0, -1/nn, -2/nn, -1, ... -1/nn,; nelem is set to 4*nn - 1
    step is maxval / nn
    Parameters:
    
    nn - number of elements
    
    shape - TRIANGLE or ZIGZAG
    
    maxval - used to compute step
  - IntArray
```
public IntArray(String[] strings)
         throws NumberFormatException
```
    construct from an array of Strings. must represent integers
    
    Parameters:
    
    strings - values as Strings
    
    Throws:
    
    NumberFormatException - a string could not be interpreted as integer
  - IntArray
```
public IntArray(String string)
         throws NumberFormatException
```
    create from a space-separated string of integers.
    
    Parameters:
    
    string - of form "1 3 56 2..."
    
    Throws:
    
    NumberFormatException - a substring could not be interpreted as integer
- Method Detail
  - clone
```
public Object clone()
```
    clone.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    the clone
  - contractArray
```
public void contractArray()
```
    contracts internal array to be of same length as number of elements. should be used if the array will be used elsewhere with a fixed length.
  - shallowCopy
```
public void shallowCopy(IntArray m)
```
    shallowCopy
    
    Parameters:
    
    m -
  - elementAt
```
public int elementAt(int elem)
              throws ArrayIndexOutOfBoundsException
```
    get element by index.
    
    Parameters:
    
    elem - the index
    
    Returns:
    
    element value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - elem >= size of this
  - size
```
public int size()
```
    get actual number of elements.
    
    Returns:
    
    number of elements
  - getArray
```
public int[] getArray()
```
    get java array.
    
    Returns:
    
    the array
  - equals
```
public boolean equals(IntArray f)
```
    are two arrays equal.
    
    Parameters:
    
    f - array to compare
    
    Returns:
    
    true if arrays are of same size and elements are equal)
  - clearArray
```
public void clearArray()
```
    clear all elements of array. sets value to 0
  - getReverseArray
```
public int[] getReverseArray()
```
    get java array in reverse order.
    
    Returns:
    
    array
  - isEqualTo
```
public boolean isEqualTo(IntArray f)
```
    are two arrays equal.
    
    Parameters:
    
    f - array to compare
    
    Returns:
    
    true if arrays are of same size and this(i) = f(i)
  - plus
```
public IntArray plus(IntArray f)
              throws EuclidRuntimeException
```
    adds arrays. does not modify this
    
    Parameters:
    
    f - array to add
    
    Returns:
    
    new array as this + f
    
    Throws:
    
    EuclidRuntimeException - f is different size from this
  - subtract
```
public IntArray subtract(IntArray f)
                  throws EuclidRuntimeException
```
    subtracts arrays. does not modify this
    
    Parameters:
    
    f - array to substract
    
    Returns:
    
    new array as this - f
    
    Throws:
    
    EuclidRuntimeException - f is different size from this
  - subtractEquals
```
public void subtractEquals(IntArray f)
                    throws EuclidRuntimeException
```
    array subtraction. modifies this -= f
    
    Parameters:
    
    f - array to subtract
    
    Throws:
    
    EuclidRuntimeException - f is different size from this
  - negative
```
public void negative()
```
    change the sign of all elements. MODIFIES this
  - multiplyBy
```
public IntArray multiplyBy(int f)
```
    array multiplication by a scalar. creates new array; does NOT modify 'this'
    
    Parameters:
    
    f - multiplier
    
    Returns:
    
    the new array
  - setElementAt
```
public void setElementAt(int elem,
                         int f)
                  throws ArrayIndexOutOfBoundsException
```
    set element value.
    
    Parameters:
    
    elem - index
    
    f - value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - elem >= size of this
  - getSubArray
```
public IntArray getSubArray(int start,
                            int end)
```
    get array slice. creates new array; does not modify this
    
    Parameters:
    
    start - index inclusive
    
    end - index inclusive
    
    Returns:
    
    new array
  - setElements
```
public void setElements(int start,
                        int[] a)
```
    set array slice. copy whole array into the array.
    
    Parameters:
    
    start - index in this
    
    a - array to copy
    
    Throws:
    
    ArrayIndexOutOfBoundsException - start < 0 or start+a.length > this.size()
  - isClear
```
public boolean isClear()
```
    is the array filled with zeros.
    
    Returns:
    
    true if this(i) = 0
  - setAllElements
```
public void setAllElements(int f)
```
    initialise array to given value. this(i) = f
    
    Parameters:
    
    f - value to set
  - sumAllElements
```
public int sumAllElements()
```
    sum all elements.
    
    Returns:
    
    sigma(this(i))
  - absSumAllElements
```
public int absSumAllElements()
```
    sum of all absolute element values.
    
    Returns:
    
    sigma(abs(this(i)))
  - innerProduct
```
public int innerProduct()
```
    inner product. dotProduct(this)
    
    Returns:
    
    sigma(this(i)**2)
  - dotProduct
```
public int dotProduct(IntArray f)
               throws EuclidRuntimeException
```
    dot product of two arrays. sigma(this(i)*(f(i));
    
    Parameters:
    
    f - array to multiply
    
    Returns:
    
    dot
    
    Throws:
    
    EuclidRuntimeException - f is different size from this
  - cumulativeSum
```
public IntArray cumulativeSum()
```
    cumulative sum of array. create new array as elem[i] = sum(k = 0 to i) f[k] does not modify 'this'
    
    Returns:
    
    each element is cumulative sum to that point
  - applyFilter
```
public IntArray applyFilter(IntArray filter)
```
    apply filter. convolute array with another array. This is 1-D image processing. If filter has <= 1 element, return this unchanged. filter should have an odd number of elements. The filter can be created with a IntArray constructor filter is moved along stepwise
    
    Parameters:
    
    filter - to apply normally smaller than this
    
    Returns:
    
    filtered array
  - trim
```
public IntArray trim(ArrayBase.Trim flag,
                     int limit)
```
    trims array to lie within limit. if flag == BELOW values below limit are set to limit. if flag == ABOVE values above limit are set to limit. by repeated use of trim() values can be constrained to lie within or outside a window does not modify this.
    
    Parameters:
    
    flag - BELOW or ABOVE
    
    limit - value to constrain
    
    Returns:
    
    new array
  - indexOfLargestElement
```
public int indexOfLargestElement()
                          throws ArrayIndexOutOfBoundsException
```
    index of largest element.
    
    Returns:
    
    index
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - indexOfSmallestElement
```
public int indexOfSmallestElement()
                           throws ArrayIndexOutOfBoundsException
```
    index of smallest element.
    
    Returns:
    
    index
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - largestElement
```
public int largestElement()
                   throws ArrayIndexOutOfBoundsException
```
    value of largest element.
    
    Returns:
    
    value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - getMax
```
public int getMax()
           throws ArrayIndexOutOfBoundsException
```
    value of largest element. synonym for largestElement();
    
    Returns:
    
    value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - smallestElement
```
public int smallestElement()
                    throws ArrayIndexOutOfBoundsException
```
    value of smallest element.
    
    Returns:
    
    index
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - getMin
```
public int getMin()
           throws ArrayIndexOutOfBoundsException
```
    value of smallest element. synonym for smallestElement();
    
    Returns:
    
    value
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - getRange
```
public IntRange getRange()
                  throws ArrayIndexOutOfBoundsException
```
    range of array.
    
    Returns:
    
    (minValue, maxValue)
    
    Throws:
    
    ArrayIndexOutOfBoundsException - array is zero length
  - deleteElement
```
public void deleteElement(int elem)
                   throws ArrayIndexOutOfBoundsException
```
    delete element and close up. modifies this.
    
    Parameters:
    
    elem - to delete
    
    Throws:
    
    ArrayIndexOutOfBoundsException - elem out of range
  - deleteElements
```
public void deleteElements(int low,
                           int high)
                    throws ArrayIndexOutOfBoundsException
```
    delete elements and close up. modifies this.
    
    Parameters:
    
    low - lowest index inclusive
    
    high - highest index inclusive
    
    Throws:
    
    ArrayIndexOutOfBoundsException - low or high out of range or low > high
  - insertElementAt
```
public void insertElementAt(int elem,
                            int f)
                     throws ArrayIndexOutOfBoundsException
```
    insert element and expand. modifies this.
    
    Parameters:
    
    elem - index of element to insert
    
    f - value of element
    
    Throws:
    
    ArrayIndexOutOfBoundsException - elem out of range
  - insertArray
```
public void insertArray(int elem,
                        IntArray f)
                 throws ArrayIndexOutOfBoundsException
```
    insert an array and expand. modifies this.
    
    Parameters:
    
    elem - index of element to insert
    
    f - value of element
    
    Throws:
    
    ArrayIndexOutOfBoundsException - elem out of range
  - addElement
```
public void addElement(int f)
```
    append element. modifies this.
    
    Parameters:
    
    f - element to append
  - addArray
```
public void addArray(IntArray f)
```
    append elements. modifies this.
    
    Parameters:
    
    f - elements to append
  - getReorderedArray
```
public IntArray getReorderedArray(IntSet idx)
                           throws EuclidRuntimeException
```
    get reordered Array. reorder by index in IntSet new(i) = this(idx(i)) does NOT modify array
    
    Parameters:
    
    idx - array of indexes
    
    Returns:
    
    array
    
    Throws:
    
    EuclidRuntimeException - an element of idx is outside range of this
  - inRange
```
public IntSet inRange(IntRange r)
```
    get elements within a range.
    
    Parameters:
    
    r - within which element values must lie
    
    Returns:
    
    indexes of conforming elements
  - outOfRange
```
public IntSet outOfRange(IntRange r)
```
    get elements outside a range.
    
    Parameters:
    
    r - outside which element values must lie
    
    Returns:
    
    indexes of conforming elements
  - getStringValues
```
public String[] getStringValues()
```
    returns values as strings.
    
    Returns:
    
    string values of elements
  - toString
```
public String toString()
```
    gets values as string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    element values seperated with spaces
  - sortAscending
```
public void sortAscending()
```
    sorts array into ascending order. MODIFIES this
  - sortDescending
```
public void sortDescending()
```
    sorts array into descending order. MODIFIES this
  - reverse
```
public void reverse()
```
    puts array into reverse order. MODIFIES this
  - indexSortAscending
```
public IntSet indexSortAscending()
```
    get indexes of ascending sorted array. this array NOT MODIFIED
    
    Returns:
    
    indexes idx so that element(idx(0)) is lowest
  - indexSortDescending
```
public IntSet indexSortDescending()
```
    get indexes of descending sorted array. this array NOT MODIFIED
    
    Returns:
    
    indexes idx so that element(idx(0)) is highest
  - isIntArray
```
public static boolean isIntArray(String s,
                                 String delimiterRegex)
```
    parse string as integerArray.
    
    Parameters:
    
    s -
    
    delimiterRegex -
    
    Returns:
    
    true if can be parsed.
  - isArithmeticProgression
```
public boolean isArithmeticProgression(int delta)
```
    returns true if array is of form: i, i+delta, i+2*delta ...
    
    Parameters:
    
    delta -
    
    Returns:
  - getConstant
```
public Integer getConstant()
```
    if all values are equal returns value else null
    
    Returns:
    
    null if no values or unequal else value
  - decrementElementAt
```
public void decrementElementAt(int i)
```
  - incrementElementAt
```
public void incrementElementAt(int i)
```
  - iterator
```
public Iterator<Integer> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Integer>
  - createIntegerSet
```
public Set<Integer> createIntegerSet()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class IntArray

Nested Class Summary

Nested classes/interfaces inherited from class org.xmlcml.euclid.ArrayBase

Field Summary

Fields inherited from class org.xmlcml.euclid.ArrayBase

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

IntArray

Method Detail

clone

contractArray

shallowCopy

elementAt

size

getArray

equals

clearArray

getReverseArray

isEqualTo

plus

subtract

subtractEquals

negative

multiplyBy

setElementAt

getSubArray

setElements

isClear

setAllElements

sumAllElements

absSumAllElements

innerProduct

dotProduct

cumulativeSum

applyFilter

trim

indexOfLargestElement

indexOfSmallestElement

largestElement

getMax

smallestElement

getMin

getRange

deleteElement

deleteElements

insertElementAt

insertArray

addElement

addArray

getReorderedArray

inRange

outOfRange

getStringValues

toString

sortAscending

sortDescending

reverse

indexSortAscending

indexSortDescending

isIntArray

isArithmeticProgression

getConstant

decrementElementAt

incrementElementAt