uk.gov.gchq.koryphe.example.function.MultiplyExample Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 Crown Copyright
 *
 * 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 uk.gov.gchq.koryphe.example.function;

import uk.gov.gchq.koryphe.example.KorypheFunctionExample;
import uk.gov.gchq.koryphe.example.annotation.Example;
import uk.gov.gchq.koryphe.impl.function.Multiply;
import uk.gov.gchq.koryphe.tuple.n.Tuple2;

import java.util.Arrays;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Stream;

/**
 * This example demonstrates a function that accepts more than one input value and returns a single result value.
 * It uses the Multiply function that accepts 2 Integer inputs, multiplying the first by the
 * second to produce the result.
 * 
 * The input values {{1, 1}, {1, 2}, {2, 2}} produces the output {1, 2, 4}.
 */
@Example(name = "Multiple input, single output function",
        description = "Applies a multiple input, single output function to a stream of multiple value inputs, " +
                "producing a stream of single value outputs.")
public class MultiplyExample extends KorypheFunctionExample, Integer> {
    @Override
    public Stream> getInput() {
        List> inputTuples = Arrays.asList(
                new Tuple2<>(1, 1),
                new Tuple2<>(1, 2),
                new Tuple2<>(2, 2));
        return inputTuples.stream();
    }

    @Override
    public Function, Integer> getFunction() {
        return new Multiply();
    }
}