org.chocosolver.util.objects.setDataStructures.ISetIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of choco-solver Show documentation

There is a newer version: 4.10.17

/*
 * This file is part of choco-solver, http://choco-solver.org/
 *
 * Copyright (c) 2022, IMT Atlantique. All rights reserved.
 *
 * Licensed under the BSD 4-clause license.
 *
 * See LICENSE file in the project root for full license information.
 */
package org.chocosolver.util.objects.setDataStructures;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * Object to iterate over an ISet values using
 * 
 *     // more readable but includes autoboxing
 *     for(int value:set){
 *         ...
 *     }
 *
 *     // more verbose but without autoboxing
 *     ISetIterator iter = set.primitiveIterator();
 *     while(iter.hasNext()){
 *         int k = iter.nextInt();
 *         ...
 *     }
 * 
 *
 * @author Jean-Guillaume Fages
 */
public interface ISetIterator extends Iterator {

	/**
	 * Reset iteration (to avoid creating a new ISetIterator for every iteration)
	 */
	void reset();

	/**
	 * Inform the iterator that value item has been removed
	 * (may require to update iterator structure)
	 * @param item removed value
	 */
	default void notifyRemoving(int item){
		// nothing to do by default
	}

	/**
	 * Returns the next int in the iteration.
	 *
	 * Beware : avoids autoboxing
	 *
	 * @return the next int in the iteration
	 * @throws NoSuchElementException if the iteration has no more elements
	 */
	int nextInt();

	@Override
	default Integer next() {
		return nextInt();
	}
}