ilog.concert
Interface IloAnd

All Superinterfaces:
IloAddable, IloConstraint, IloIntExpr, IloNumExpr

public interface IloAnd
extends IloConstraint

This interface defines the API for classes that represent and-constraints.

An IloAnd constraint is a multiple set of constraints. Objects of type IloConstraint can be added to and removed from an instance of IloAnd. The constraints in an and-constraint can be queried by the iterator returned by the method iterator.


Method Summary
 IloConstraint add(IloConstraint object)
          This method adds the constraint to the invoking and-constraint.
 IloConstraint[] add(IloConstraint[] objects)
          This method adds the array of constraints to the invoking and-constraint.
 IloConstraint[] add(IloConstraint[] objects, int start, int num)
          This method adds constraints to the invoking instance of IloAnd.
 java.util.Iterator iterator()
          This method returns an iterator that traverses the constraints in the and-constraint.
 IloConstraint remove(IloConstraint object)
          This method removes the constraints from the invoking and-constraint.
 IloConstraint[] remove(IloConstraint[] objects)
          This method removes the array of constraints from the invoking and-constraint.
 IloConstraint[] remove(IloConstraint[] objects, int start, int num)
          This method removes constraints from the invoking instance of IloAnd.
 
Methods inherited from interface ilog.concert.IloAddable
getName, setName
 

Method Detail

add

public IloConstraint add(IloConstraint object)
                  throws IloException
This method adds the constraint to the invoking and-constraint.

Parameters:
object - The constraint to be added to the invoking instance of IloAnd.
Returns:
The constraint that has been added.
Throws:
IloException

add

public IloConstraint[] add(IloConstraint[] objects)
                    throws IloException
This method adds the array of constraints to the invoking and-constraint.

Parameters:
objects - The array of constraints to be added to the invoking instance of IloAnd.
Returns:
The array of constraints that have been added.
Throws:
IloException

add

public IloConstraint[] add(IloConstraint[] objects,
                           int start,
                           int num)
                    throws IloException
This method adds constraints to the invoking instance of IloAnd.

All objects implementing the IloConstraint interface objects[start]...objects[start+num-1] are added to the invoking IloAnd object.

Parameters:
objects - The array of constraints to be added to the invoking instance of IloAnd.
start - The first constraint to be added to the invoking instance of IloAnd.
num - The number of constraints to be added to the invoking instance of IloAnd.
Returns:
The array of constraints that have been added.
Throws:
IloException

remove

public IloConstraint remove(IloConstraint object)
                     throws IloException
This method removes the constraints from the invoking and-constraint.

If the constraint has been added multiple times, only one instance is removed from the and-constraint.

Parameters:
object - The constraint to be removed from the invoking instance of IloAnd.
Throws:
IloException

remove

public IloConstraint[] remove(IloConstraint[] objects)
                       throws IloException
This method removes the array of constraints from the invoking and-constraint.

Parameters:
objects - The array of constraints to be removed from the invoking IloAnd.
Throws:
IloException

remove

public IloConstraint[] remove(IloConstraint[] objects,
                              int start,
                              int num)
                       throws IloException
This method removes constraints from the invoking instance of IloAnd.

The constraints or, more precisely, the objects implementing the IloConstraint interface objects[start]...objects[start+num-1] are removed from the invoking instance of IloAnd. If a constraint has been added multiple times, only one instance is removed from the and-constraint.

Parameters:
objects - The array of constraints to be removed from the invoking instance of IloAnd.
start - The first constraints to be removed from the invoking instance of IloAnd.
num - The number of constraints to be removed from the invoking instance of IloAnd.
Throws:
IloException

iterator

public java.util.Iterator iterator()
This method returns an iterator that traverses the constraints in the and-constraint.

Any manipulation of the and-constraint will render an iterator accessed with this method invalid. An iterator can be used only until the method add, remove, or delete is called on the invoking instance of IloAnd.