IrBoolDomain (chocosolver 0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<IrBoolDomain>
- - org.clafer.ir.IrBoolDomain

All Implemented Interfaces:

Serializable, Comparable<IrBoolDomain>, IrDomain
```
public enum IrBoolDomain
extends Enum<IrBoolDomain>
implements IrDomain
```
Boolean domain.

Author:

jimmy

Enum Constant Summary

Enum Constants
Enum Constant and Description

BoolDomain

FalseDomain

TrueDomain

Enum Constants
Enum Constant and Description
`BoolDomain`
`FalseDomain`
`TrueDomain`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`contains(boolean value)`
`boolean`	`contains(int value)` Checks if a value is within this domain.
`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.
`IrBoolDomain`	`invert()` Reverse the domain.
`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.
`static IrBoolDomain`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IrBoolDomain[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - TrueDomain
```
public static final IrBoolDomain TrueDomain
```
  - FalseDomain
```
public static final IrBoolDomain FalseDomain
```
  - BoolDomain
```
public static final IrBoolDomain BoolDomain
```
- Method Detail
  - values
```
public static IrBoolDomain[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (IrBoolDomain c : IrBoolDomain.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IrBoolDomain valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isBounded
```
public boolean isBounded()
```
    Description copied from interface: IrDomain
    
    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(boolean value)
```
    Parameters:
    value - test this value
    
    Returns:
    true if and only if the domain contains the value, false otherwise
  - contains
```
public boolean contains(int value)
```
    Description copied from interface: IrDomain
    
    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()
```
    Description copied from interface: IrDomain
    
    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()
```
    Description copied from interface: IrDomain
    
    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()
```
    Description copied from interface: IrDomain
    
    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()
```
    Description copied from interface: IrDomain
    
    Returns how many values are contained in this domain.
    
    Specified by:
    
    size in interface IrDomain
    
    Returns:
    the size of this domain
  - invert
```
public IrBoolDomain invert()
```
    Reverse the domain. Maps {0}->{1}, {1}->{0}, and {0,1}->{0,1}.
    
    Returns:
    the inverted domain
  - getValues
```
public int[] getValues()
```
    Description copied from interface: IrDomain
    
    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()
```
    Description copied from interface: IrDomain
    
    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)
```
    Description copied from interface: IrDomain
    
    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)
```
    Description copied from interface: IrDomain
    
    Put the contents of this domain inside the collection.
    
    Specified by:
    
    transferTo in interface IrDomain
    
    Parameters:
    collection - the collection
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<IrBoolDomain>

Enum IrBoolDomain

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TrueDomain

FalseDomain

BoolDomain

Method Detail

values

valueOf

isBounded

contains

contains

getLowBound

getHighBound

isEmpty

size

invert

getValues

iterator

iterator

transferTo

toString