com.exigen.ie.constrainer.Domain Maven / Gradle / Ivy
package com.exigen.ie.constrainer;
///////////////////////////////////////////////////////////////////////////////
/*
* Copyright Exigen Group 1998, 1999, 2000
* 320 Amboy Ave., Metuchen, NJ, 08840, USA, www.exigengroup.com
*
* The copyright to the computer program(s) herein
* is the property of Exigen Group, USA. All rights reserved.
* The program(s) may be used and/or copied only with
* the written permission of Exigen Group
* or in accordance with the terms and conditions
* stipulated in the agreement/contract under which
* the program(s) have been supplied.
*/
///////////////////////////////////////////////////////////////////////////////
//import java.util.Set;
/**
* An interface for the domain of the constrained integer variable.
* Domain is a set of the possible values of the constrained variables.
* @see IntVar
*/
public interface Domain extends java.io.Serializable
{
/**
* Returns a constrainer that owns this domain.
*/
public Constrainer constrainer();
/**
* Returns true if this domain contains the value.
*/
public boolean contains(int value);
/**
* Returns the type of this domain.
*/
public int type();
/**
* Returns the largest value in this domain.
*/
public int max();
/**
* Returns the smallest value in this domain.
*/
public int min();
/**
* Removes the value from this domain.
*
* @throws Failure if domain becomes empty.
*/
public boolean removeValue(int value) throws Failure;
/**
* Removes the range from this domain.
*
* @throws Failure if domain becomes empty.
*/
public boolean removeRange(int min, int max) throws Failure;
/**
* Sets the maximum value for this domain.
*
* @throws Failure if domain becomes empty.
*/
public boolean setMax(int M) throws Failure;
/**
* Sets the minimum value for this domain.
*
* @throws Failure if domain becomes empty.
*/
public boolean setMin(int m) throws Failure;
/**
* Sets this domain to the damain containing only the value.
*
* @throws Failure if domain becomes empty.
*/
public boolean setValue(int value) throws Failure;
/**
* Returns the size (cardinality) of this domain.
*/
public int size();
/**
* Iterates this domain calling it.doSomethingOrStop() for each values in the domain.
*/
public void iterateDomain(IntExp.IntDomainIterator it) throws Failure;
/**
* Sets the variable associated with this domain.
*/
public void variable(IntVar var);
/**
* Undo helper: sets the minimum value for this domain.
*/
public void forceMin(int min);
/**
* Undo helper: sets the maximum value for this domain.
*/
public void forceMax(int max);
/**
* Undo helper: insert the value into this domain.
*/
public void forceInsert(int val);
/**
* Undo helper: sets the size for this domain.
*/
public void forceSize(int val);
//public Set set();
} // ~Domain