org.irlab.cartesianproduct.Iterable2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cartesian-product Show documentation

Iterable of the cartesian product of Iterables

The newest version!

/*
 * Copyright 2019 Information Retrieval Lab - University of A Coruña
 *
 * 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 org.irlab.cartesianproduct;

import java.util.Iterator;
import java.util.Spliterator;
import java.util.function.Consumer;

import org.jooq.lambda.function.Consumer2;
import org.jooq.lambda.tuple.Tuple2;

/**
 * Iterable of two-arity tuples that also has a forEach with two arguments.
 *
 * @param  the type of the first element
 * @param  the type of the second element
 *
 * @author [email protected]
 */
@FunctionalInterface
public interface Iterable2 extends Iterable> {

    /**
     * Performs the give action for each tuple of the {@link Iterable2}.
     *
     * @param action The action to be performed for each tuple.
     */
    default void forEach(final Consumer2 action) {
        forEach(pair -> action.accept(pair.v1, pair.v2));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    Iterator> iterator();

    /**
     * {@inheritDoc}
     */
    @Override
    default void forEach(final Consumer> action) {
        Iterable.super.forEach(action);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    default Spliterator> spliterator() {
        return Iterable.super.spliterator();
    }

}