it.unimi.dsi.fastutil.ints.AbstractIntSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fastutil-core Show documentation

fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast operations; it provides also big (64-bit) arrays, sets, and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. This jar (fastutil-core.jar) contains data structures based on integers, longs, doubles, and objects, only; fastutil.jar contains all classes. If you have both jars in your dependencies, this jar should be excluded.

There is a newer version: 8.5.15

Show newest version

/*
	* Copyright (C) 2002-2022 Sebastiano Vigna
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	*     http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/
package it.unimi.dsi.fastutil.ints;

import java.util.Set;

/**
 * An abstract class providing basic methods for sets implementing a type-specific interface.
 *
 * 
 * Note that the type-specific {@link Set} interface adds a type-specific {@code remove()} method,
 * as it is no longer harmful for subclasses. Thus, concrete subclasses of this class must implement
 * {@code remove()} (the {@code rem()} implementation of this class just delegates to
 * {@code remove()}).
 */
public abstract class AbstractIntSet extends AbstractIntCollection implements Cloneable, IntSet {
	protected AbstractIntSet() {
	}

	@Override
	public abstract IntIterator iterator();

	@Override
	public boolean equals(final Object o) {
		if (o == this) return true;
		if (!(o instanceof Set)) return false;
		Set s = (Set)o;
		if (s.size() != size()) return false;
		if (s instanceof IntSet) {
			return containsAll((IntSet)s);
		}
		return containsAll(s);
	}

	/**
	 * Returns a hash code for this set.
	 *
	 * The hash code of a set is computed by summing the hash codes of its elements.
	 *
	 * @return a hash code for this set.
	 */
	@Override
	public int hashCode() {
		int h = 0, n = size();
		IntIterator i = iterator();
		int k;
		while (n-- != 0) {
			k = i.nextInt(); // We need k because KEY2JAVAHASH() is a macro with repeated evaluation.
			h += (k);
		}
		return h;
	}

	/**
	 * {@inheritDoc} Delegates to the type-specific {@code rem()} method implemented by type-specific
	 * abstract {@link java.util.Collection} superclass.
	 */
	@Override
	public boolean remove(int k) {
		return super.rem(k);
	}

	/**
	 * {@inheritDoc} Delegates to the type-specific {@code remove()} method specified in the
	 * type-specific {@link Set} interface.
	 * 
	 * @deprecated Please use {@code remove()} instead.
	 */
	@Deprecated
	@Override
	public boolean rem(int k) {
		return remove(k);
	}
}