it.unimi.dsi.fastutil.chars.CharIterable Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* 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.chars;
import java.lang.Iterable;
import java.util.Objects;
import java.util.function.Consumer;
import it.unimi.dsi.fastutil.ints.IntIterator;
import it.unimi.dsi.fastutil.ints.IntIterators;
import it.unimi.dsi.fastutil.ints.IntSpliterator;
import it.unimi.dsi.fastutil.ints.IntSpliterators;
/**
* A type-specific {@link Iterable} that strengthens that specification of {@link #iterator()} and
* {@link #forEach(Consumer)}.
*
*
* Note that whenever there exist a primitive consumer in {@link java.util.function} (e.g.,
* {@link java.util.function.IntConsumer}), trying to access any version of
* {@link #forEach(Consumer)} using a lambda expression with untyped arguments will generate an
* ambiguous method error. This can be easily solved by specifying the type of the argument, as in
*
*
* intIterable.forEach((int x) -> { // Do something with x });
*
*
* The same problem plagues, for example,
* {@link java.util.PrimitiveIterator.OfInt#forEachRemaining(java.util.function.IntConsumer)}.
*
*
* Warning: Java will let you write “colon” {@code for} statements with
* primitive-type loop variables; however, what is (unfortunately) really happening is that at each
* iteration an unboxing (and, in the case of {@code fastutil} type-specific data structures, a
* boxing) will be performed. Watch out.
*
* @see Iterable
*/
public interface CharIterable extends Iterable {
/**
* Returns a type-specific iterator.
*
* @apiNote Note that this specification strengthens the one given in {@link Iterable#iterator()}.
*
* @return a type-specific iterator.
* @see Iterable#iterator()
*/
@Override
CharIterator iterator();
/**
* Returns a widened primitive iterator on the elements of this iterable.
*
*
* This method is provided for the purpose of APIs that expect only the JDK's primitive iterators,
* of which there are only {@code int}, {@code long}, and {@code double}.
*
*
* WARNING: This is not the same as converting the source to a sequence of code
* points. This returned instance literally performs {@code (int)(charValue)} casts. Surrogate pairs
* will be left as separate elements instead of combined into a single element with the code point
* it represents. See {@link Character} for more discussion on code points, char values, and
* surrogate pairs.
*
* @return a widened primitive iterator on the elements of this iterable.
* @since 8.5.0
*/
default IntIterator intIterator() {
return IntIterators.wrap(iterator());
}
// If you change these default spliterator methods, you will likely need to update Collection, List,
// Set, and SortedSet too.
/**
* Returns a type-specific spliterator on the elements of this iterable.
*
* @apiNote Note that this specification strengthens the one given in
* {@link java.lang.Iterable#spliterator()}.
*
* @return a type-specific spliterator on the elements of this iterable.
* @since 8.5.0
*/
@Override
default CharSpliterator spliterator() {
return CharSpliterators.asSpliteratorUnknownSize(iterator(), 0);
}
/**
* Returns widened primitive spliterator on the elements of this iterable.
*
*
* This method is provided for the purpose of APIs that expect only the JDK's primitive
* spliterators, of which there are only {@code int}, {@code long}, and {@code double}.
*
*
* WARNING: This is not the same as converting the source to a sequence of code
* points. This returned instance literally performs {@code (int)(charValue)} casts. Surrogate pairs
* will be left as separate elements instead of combined into a single element with the code point
* it represents. See {@link Character} for more discussion on code points, char values, and
* surrogate pairs.
*
* @implSpec The default implementation widens the spliterator from {@link #spliterator()}.
* @return a widened primitive spliterator on the elements of this iterable.
* @since 8.5.0
*/
default IntSpliterator intSpliterator() {
return IntSpliterators.wrap(spliterator());
}
/**
* Performs the given action for each element of this type-specific {@link java.lang.Iterable} until
* all elements have been processed or the action throws an exception.
*
* @param action the action to be performed for each element.
* @see java.lang.Iterable#forEach(java.util.function.Consumer)
* @since 8.0.0
* @apiNote Implementing classes should generally override this method, and take the default
* implementation of the other overloads which will delegate to this method (after proper
* conversions).
*/
default void forEach(final CharConsumer action) {
Objects.requireNonNull(action);
iterator().forEachRemaining(action);
}
/**
* Performs the given action for each element of this type-specific {@link java.lang.Iterable},
* performing widening primitive casts, until all elements have been processed or the action throws
* an exception.
*
* @param action the action to be performed for each element.
* @see java.lang.Iterable#forEach(java.util.function.Consumer)
* @since 8.0.0
* @implNote Unless the argument is type-specific, this method will introduce an intermediary lambda
* to perform widening casts. Please use the type-specific overload to avoid this
* overhead.
*/
default void forEach(final java.util.function.IntConsumer action) {
Objects.requireNonNull(action);
forEach(action instanceof CharConsumer ? (CharConsumer)action : (CharConsumer)action::accept);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default void forEach(final Consumer action) {
Objects.requireNonNull(action);
// The instanceof and cast is required for performance. Without it, calls routed through this
// overload using a primitive consumer would go through the slow lambda.
forEach(action instanceof CharConsumer ? (CharConsumer)action : (CharConsumer)action::accept);
}
}