javax.constraints.VarSelector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsr331 Show documentation

JCP Standard JSR331 “Java Constraint Programming API”. It is used for Modeling and Solving Constraint Satisfaction and Optimization Problems using Java and off-the-shelf Constraint/Linear Solvers

There is a newer version: 2.3.1

Show newest version

package javax.constraints;

/**
 * This is a common interface for selection of a constrained
 * variable from an array of variables. Used inside search strategies.
 */

public interface VarSelector {
	
	/**
	 * Returns a type of this selector
	 * @return a type of this selector
	 */
	public VarSelectorType getType();
	
	/**
	 * Return a search strategy with which this selector is associated
	 * @return a search strategy with which this selector is associated
	 */
	public SearchStrategy getSearchStrategy();

	/**
	 * Returns the array of constrained variables upon which this selector was defined.
	 * @return the array of constrained variables upon which
	 * this selector was defined.
	 */
	public Var[] getVars();

	/**
	 * Returns the index of the selected variable in the array of constrained
	 * variables upon which this selector was defined. If no
	 * variables to select, it returns -1;
	 * @return the index of the selected variable in the array of constrained 
	 *         variables upon which this selector was defined. Returns -1 if
	 *         there are no variables to select.
	 */
	public int select();

}