/*
 * #%L
 * ImageJ OPS: a framework for reusable algorithms.
 * %%
 * Copyright (C) 2014 Board of Regents of the University of
 * Wisconsin-Madison and University of Konstanz.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package imagej.ops;

import org.scijava.ItemIO;

/**
 * A function (in this context) is an {@link Op} that has a typed input
 * parameter, and a typed output parameter.
 * <p>
 * The function provides a {@link #compute} method to compute the function for
 * different input and output parameters.
 * </p>
 * <p>
 * Note that the typed output is actually considered both an input <em>and</em>
 * an output parameter; in ImageJ module terms, its type is {@link ItemIO#BOTH}.
 * This fact is critical so that a preallocated data structure may be passed in
 * and filled by the function. It is <em>required</em> that if an output value
 * is given in this way, it will be populated with the function's result.
 * </p>
 * 
 * @author Christian Dietz
 * @author Martin Horn
 * @author Curtis Rueden
 */
public interface Function<I, O> extends Op {

	I getInput();

	O getOutput();

	void setInput(I input);

	void setOutput(O output);

	O compute(I input, O output);

}

/*
 * #%L
 * ImageJ OPS: a framework for reusable algorithms.
 * %%
 * Copyright (C) 2014 Board of Regents of the University of
 * Wisconsin-Madison and University of Konstanz.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package imagej.ops;

import org.scijava.ItemIO;

/**
 * A {@code Function} is an {@link Op} that has a typed input parameter, and a
 * typed output parameter.
 * <p>
 * The function provides a {@link #compute} method to compute the function for
 * different input and output parameters.
 * </p>
 * <p>
 * Note that the typed output is actually considered both an input <em>and</em>
 * an output parameter; in ImageJ module terms, its type is {@link ItemIO#BOTH}.
 * This fact is critical so that a preallocated data structure may be passed in
 * and filled by the function. It is <em>required</em> that if an output value
 * is given in this way, it will be populated with the function's result.
 * </p>
 * 
 * @author Christian Dietz
 * @author Martin Horn
 * @author Curtis Rueden
 */
public interface Function<I, O> extends Op {

	I getInput();

	O getOutput();

	void setInput(I input);

	void setOutput(O output);

	O compute(I input, O output);

}

tweak javadoc