it.unimi.dsi.fastutil.bytes.ByteBidirectionalIterator Maven / Gradle / Ivy

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

fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast access and insertion; 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. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.

There is a newer version: 8.5.13

Show newest version

/*
	* Copyright (C) 2002-2023 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.bytes;

import it.unimi.dsi.fastutil.BidirectionalIterator;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;

/**
 * A type-specific bidirectional iterator; provides an additional method to avoid (un)boxing, and
 * the possibility to skip elements backwards.
 *
 * @see BidirectionalIterator
 */
public interface ByteBidirectionalIterator extends ByteIterator, ObjectBidirectionalIterator {
	/**
	 * Returns the previous element as a primitive type.
	 *
	 * @return the previous element in the iteration.
	 * @see java.util.ListIterator#previous()
	 */
	byte previousByte();

	/**
	 * {@inheritDoc}
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	default Byte previous() {
		return Byte.valueOf(previousByte());
	}

	/**
	 * Moves back for the given number of elements.
	 *
	 * 
	 * The effect of this call is exactly the same as that of calling {@link #previous()} for {@code n}
	 * times (possibly stopping if {@link #hasPrevious()} becomes false).
	 *
	 * @param n the number of elements to skip back.
	 * @return the number of elements actually skipped.
	 * @see #previous()
	 */
	@Override
	default int back(final int n) {
		int i = n;
		while (i-- != 0 && hasPrevious()) previousByte();
		return n - i - 1;
	}

	/** {@inheritDoc} */
	@Override
	default int skip(final int n) {
		return ByteIterator.super.skip(n);
	}
}