/*
	* Copyright (C) 2010-2019 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.booleans;
import it.unimi.dsi.fastutil.BigListIterator;
import it.unimi.dsi.fastutil.SafeMath;
A type-specific BigListIterator. 
See Also:
BigListIterator/**
 * A type-specific {@link BigListIterator}.
 *
 * @see BigListIterator
 */
public interface BooleanBigListIterator extends BooleanBidirectionalIterator, BigListIterator<Boolean> {
	
Replaces the last element returned by next() or previous() with the specified element (optional operation). 
See Also:
ListIterator.set(Object)/**
	 * Replaces the last element returned by {@link BigListIterator#next() next()}
	 * or {@link BigListIterator#previous() previous()} with the specified element
	 * (optional operation).
	 * 
	 * @see java.util.ListIterator#set(Object)
	 */
	default void set(@SuppressWarnings("unused") final boolean k) {
		throw new UnsupportedOperationException();
	}
	
Inserts the specified element into the list (optional operation).
See Also:
add.add(Object)/**
	 * Inserts the specified element into the list (optional operation).
	 * 
	 * @see java.util.ListIterator#add(Object)
	 */
	default void add(@SuppressWarnings("unused") final boolean k) {
		throw new UnsupportedOperationException();
	}
	
Replaces the last element returned by BooleanIterator.next() or BooleanBidirectionalIterator.previous() with the specified element (optional operation). 
Deprecated:
Please use the corresponding type-specific method instead./**
	 * Replaces the last element returned by {@link #next()} or {@link #previous()}
	 * with the specified element (optional operation).
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	default void set(final Boolean k) {
		set(k.booleanValue());
	}
	
Inserts the specified element into the list (optional operation).
Deprecated:
Please use the corresponding type-specific method instead./**
	 * Inserts the specified element into the list (optional operation).
	 * 
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	@Override
	default void add(final Boolean k) {
		add(k.booleanValue());
	}
	
Skips the given number of elements.
 The effect of this call is exactly the same as that of calling next() for n times (possibly stopping if Iterator<Boolean>.hasNext() becomes false). 
Params:
n – 
           the number of elements to skip.
See Also:
Iterator.next()
Returns:
the number of elements actually skipped./**
	 * Skips the given number of elements.
	 *
	 * <p>
	 * The effect of this call is exactly the same as that of calling
	 * {@link BigListIterator#next() next()} for {@code n} times (possibly stopping
	 * if {@link #hasNext()} becomes false).
	 *
	 * @param n
	 *            the number of elements to skip.
	 * @return the number of elements actually skipped.
	 * @see BigListIterator#next()
	 */
	default long skip(final long n) {
		long i = n;
		while (i-- != 0 && hasNext())
			nextBoolean();
		return n - i - 1;
	}
	
Moves back for the given number of elements.
 The effect of this call is exactly the same as that of calling previous() for n times (possibly stopping if BidirectionalIterator<Boolean>.hasPrevious() becomes false). 
Params:
n – 
           the number of elements to skip back.
See Also:
BidirectionalIterator.previous()
Returns:
the number of elements actually skipped./**
	 * Moves back for the given number of elements.
	 *
	 * <p>
	 * The effect of this call is exactly the same as that of calling
	 * {@link BigListIterator#previous() 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 BigListIterator#previous()
	 */
	default long back(final long n) {
		long i = n;
		while (i-- != 0 && hasPrevious())
			previousBoolean();
		return n - i - 1;
	}
	
{@inheritDoc}
/**
	 * {@inheritDoc}
	 */
	@Override
	default int skip(int n) {
		return SafeMath.safeLongToInt(skip((long) n));
	}
}