org.clafer.ir

Class IrEnumDomain

java.lang.Object

org.clafer.ir.IrEnumDomain

All Implemented Interfaces:

IrDomain

public class IrEnumDomain
extends Object
implements IrDomain

A domain over explicitly defined values.

Author:

jimmy

Constructor Summary

Constructors

Constructor and Description
IrEnumDomain(int[] values)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(int value) Checks if a value is within this domain.
boolean	equals(Object obj)
int	getHighBound() Returns the largest integer contained in this domain.
int	getLowBound() Returns the smallest integer contained in this domain.
int[]	getValues() Returns all the values contained in this domain.
int	hashCode()
boolean	isBounded() Checks if this domain is defined as a lower and upper bound.
boolean	isEmpty() Checks if this domain contains any values.
gnu.trove.iterator.TIntIterator	iterator() Iterate over the domain in increasing order.
gnu.trove.iterator.TIntIterator	iterator(boolean increasing) Iterate over the domain in the specified order.
int	size() Returns how many values are contained in this domain.
String	toString()
void	transferTo(gnu.trove.TIntCollection collection) Put the contents of this domain inside the collection.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IrEnumDomain

public IrEnumDomain(int[] values)

Parameters:

values - sorted, unique, and immutable integers

Method Detail

isBounded

public boolean isBounded()

Checks if this domain is defined as a lower and upper bound. If the domain is bounded then it contains every value between its lower and upper bound.

Specified by:

isBounded in interface IrDomain

Returns:

true if and only if this domain is a contiguous interval, false otherwise

contains

public boolean contains(int value)

Checks if a value is within this domain.

Specified by:

contains in interface IrDomain

Parameters:

value - test this value

Returns:

true if and only if this domain contains the value, false otherwise

getLowBound

public int getLowBound()

Returns the smallest integer contained in this domain. Undefined if this domain is empty.

Specified by:

getLowBound in interface IrDomain

Returns:

the smallest integer contained in this domain

getHighBound

public int getHighBound()

Returns the largest integer contained in this domain. Undefined if this domain is empty.

Specified by:

getHighBound in interface IrDomain

Returns:

the largest integer contained in this domain

isEmpty

public boolean isEmpty()

Checks if this domain contains any values.

Specified by:

isEmpty in interface IrDomain

Returns:

true if and only if the size of this domain is zero, false otherwise

size

public int size()

Returns how many values are contained in this domain.

Specified by:

size in interface IrDomain

Returns:

the size of this domain

getValues

public int[] getValues()

Returns all the values contained in this domain.

Specified by:

getValues in interface IrDomain

Returns:

values contained in this domain

iterator

public gnu.trove.iterator.TIntIterator iterator()

Iterate over the domain in increasing order.

Specified by:

iterator in interface IrDomain

Returns:

an iterator over the values in this domain in increasing order

iterator

public gnu.trove.iterator.TIntIterator iterator(boolean increasing)

Iterate over the domain in the specified order.

Specified by:

iterator in interface IrDomain

Parameters:

increasing - increasing or decreasing order

Returns:

an iterator over the values in this domain in the order specified

transferTo

public void transferTo(gnu.trove.TIntCollection collection)

Put the contents of this domain inside the collection.

Specified by:

transferTo in interface IrDomain

Parameters:

collection - the collection

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object