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

Go to download

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

There is a newer version: 2.5.2

/*
 * 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.DivideBy;
import uk.gov.gchq.koryphe.tuple.n.Tuple2;

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

/**
 * This example demonstrates a function that returns more than one result value. It uses the DivideBy
 * function that accepts a single Integer input, using a control value to produce the division
 * result and modulus.
 *
 * The input values {3, 6, 10} with a control value of 3 produces the output
 * {{1, 0}, {2, 0}, {3, 1}}.
 */
@Example(name = "Single input, multiple output function",
         description = "Applies a single input, multiple output function to a stream of single value inputs, producing " +
         "a stream of multiple value outputs.")
public class DivideByExample extends KorypheFunctionExample> {
    @Override
    public Stream getInput() {
        return Arrays.asList(3, 6, 10).stream();
    }

    @Override
    public Function> getFunction() {
        return new DivideBy(3);
    }
}