IntSet (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.IntSet

All Implemented Interfaces:

EuclidConstants
```
public class IntSet
extends Object
implements EuclidConstants
```
public class IntSet Stores a unique set of ints (that is cannot contain duplicate ints. The limits can be set with setMin and setMax. There are operations for combining sets (for example NOT, OR) and sets can be built up incrementally.
Inverse mapping. IntSets can be used to map one set of indexed data to another, for example
RealArray x = someFunction(); InstSet idx = x.indexSortAscending(); for (int i = 0; i <x.size(); i++) { y[i] = x[idx[i]]; } To map the other way, x[i] = y[inv[i]]; the inverse IntSet can be used

Author:

(C) P. Murray-Rust, 1996

Field Summary

Fields
Modifier and Type Field and Description

static Map<Integer,List<List<Integer>>> integerMap
- 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

Fields
Modifier and Type	Field and Description
`static Map<Integer,List<List<Integer>>>`	`integerMap`

Constructor Summary

Constructors
Constructor and Description
`IntSet()` constructor.
`IntSet(int nelem)` creates an IntSet with the integers 0...nelem-1
`IntSet(int[] is)` make from an int[] - all values must be distinct;
`IntSet(int start, int end)` creates an IntSet with the integers start...end (if start <= end)
`IntSet(IntSet is)` copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addElement(int value)` add integer Fails if it is outside limits or already exists in set
`void`	`addRange(IntRange ir)` add all values from an IntRange if range is 2,5 adds 2,3,4,5
`void`	`addSet(IntSet is)` concatenate sets.
`boolean`	`contains(int value)` does set contain value.
`void`	`debug()` debug.
`int`	`elementAt(int i)` get element.
`int[]`	`getElements()` get elements.
`IntArray`	`getIntArray()` gets the ints as an IntArray.
`static List<int[]>`	`getPermutations(Integer number)` create all permutations of an integer.
`IntSet`	`getSubscriptedIntSet(IntSet sub)` use another IntSet to subscript this one that is I(new) = I(this) subscripted by I(sub); Result has dimension of I(sub).
`IntSet`	`intersectionWith(IntSet is)` intersect two sets (that is elements common to both)
`IntSet`	`inverseMap()` Inverse mapping - see introduction if `y[i] = x[this.elementAt(i)];` then the result supports `x[i] = y[inv.elementAt(i)];`
`boolean`	`isEqualTo(IntSet is)` element-by-element comparison of sets
`IntSet`	`notIn(IntSet is)` elements only in first set
`void`	`setMax(int max)` set maximum allowed value.
`void`	`setMin(int min)` set minimum allowed value.
`int`	`size()` size of array.
`void`	`sortAscending()` sort the IntSet; MODIFIES 'this'
`String`	`toString()` to string.

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

- Field Detail
  - integerMap
```
public static Map<Integer,List<List<Integer>>> integerMap
```
- Constructor Detail
  - IntSet
```
public IntSet()
```
    constructor.
  - IntSet
```
public IntSet(int nelem)
```
    creates an IntSet with the integers 0...nelem-1
    
    Parameters:
    
    nelem -
  - IntSet
```
public IntSet(int start,
              int end)
```
    creates an IntSet with the integers start...end (if start <= end)
    
    Parameters:
    
    start -
    
    end -
  - IntSet
```
public IntSet(IntSet is)
```
    copy constructor
    
    Parameters:
    
    is -
  - IntSet
```
public IntSet(int[] is)
       throws EuclidRuntimeException
```
    make from an int[] - all values must be distinct;
    
    Parameters:
    
    is -
    
    Throws:
    
    EuclidRuntimeException - values were not distinct
- Method Detail
  - getSubscriptedIntSet
```
public IntSet getSubscriptedIntSet(IntSet sub)
                            throws EuclidRuntimeException
```
    use another IntSet to subscript this one that is I(new) = I(this) subscripted by I(sub); Result has dimension of I(sub). If any of I(sub) lies outside 0...this.size()-1, throw an error
    
    Parameters:
    
    sub -
    
    Returns:
    
    the matrix
    
    Throws:
    
    EuclidRuntimeException
  - isEqualTo
```
public boolean isEqualTo(IntSet is)
```
    element-by-element comparison of sets
    
    Parameters:
    
    is -
    
    Returns:
    
    equal
  - getElements
```
public int[] getElements()
```
    get elements.
    
    Returns:
    
    elements as array
  - setMax
```
public void setMax(int max)
            throws EuclidRuntimeException
```
    set maximum allowed value. if current set has elements greater than max throws exception.
    
    Parameters:
    
    max -
    
    Throws:
    
    EuclidRuntimeException
  - setMin
```
public void setMin(int min)
```
    set minimum allowed value. if current set has elements less than min throws exception.
    
    Parameters:
    
    min -
    
    Throws:
    
    EuclidRuntimeException
  - size
```
public int size()
```
    size of array.
    
    Returns:
    
    size
  - addElement
```
public boolean addElement(int value)
                   throws EuclidRuntimeException
```
    add integer Fails if it is outside limits or already exists in set
    
    Parameters:
    
    value -
    
    Returns:
    
    if successful
    
    Throws:
    
    EuclidRuntimeException
  - contains
```
public boolean contains(int value)
```
    does set contain value.
    
    Parameters:
    
    value -
    
    Returns:
    
    tur if contains
  - elementAt
```
public int elementAt(int i)
              throws ArrayIndexOutOfBoundsException
```
    get element.
    
    Parameters:
    
    i -
    
    Returns:
    
    element
    
    Throws:
    
    ArrayIndexOutOfBoundsException
  - getIntArray
```
public IntArray getIntArray()
```
    gets the ints as an IntArray.
    
    Returns:
    
    the array
    
    See Also:
    
    getElements()
  - sortAscending
```
public void sortAscending()
```
    sort the IntSet; MODIFIES 'this'
  - addSet
```
public void addSet(IntSet is)
            throws EuclidRuntimeException
```
    concatenate sets.
    
    Parameters:
    
    is - set to append
    
    Throws:
    
    EuclidRuntimeException - if there are elements in common or exceed max/min
  - intersectionWith
```
public IntSet intersectionWith(IntSet is)
```
    intersect two sets (that is elements common to both)
    
    Parameters:
    
    is -
    
    Returns:
    
    set
  - notIn
```
public IntSet notIn(IntSet is)
```
    elements only in first set
    
    Parameters:
    
    is -
    
    Returns:
    
    set
  - addRange
```
public void addRange(IntRange ir)
```
    add all values from an IntRange if range is 2,5 adds 2,3,4,5
    
    Parameters:
    
    ir -
  - inverseMap
```
public IntSet inverseMap()
                  throws ArrayIndexOutOfBoundsException
```
    Inverse mapping - see introduction if y[i] = x[this.elementAt(i)]; then the result supports x[i] = y[inv.elementAt(i)];
    
    Returns:
    
    inverse map
    
    Throws:
    
    ArrayIndexOutOfBoundsException - the set must contain the integers 0...nelem-1
  - debug
```
public void debug()
```
    debug.
  - toString
```
public String toString()
```
    to string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - getPermutations
```
public static List<int[]> getPermutations(Integer number)
```
    create all permutations of an integer. runs from 0,1,... number-1
    
    Parameters:
    
    number -
    
    Returns:

Class IntSet

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

integerMap

Constructor Detail

IntSet

IntSet

IntSet

IntSet

IntSet

Method Detail

getSubscriptedIntSet

isEqualTo

getElements

setMax

setMin

size

addElement

contains

elementAt

getIntArray

sortAscending

addSet

intersectionWith

notIn

addRange

inverseMap

debug

toString

getPermutations