/*
 * #%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;
import org.scijava.plugin.Parameter;

/**
 * TODO
 * 
 * @author Christian Dietz
 * @author Martin Horn
 * @author Curtis Rueden
 */
public abstract class Function<I, O> implements Op, Copyable {

	@Parameter
	private I in;

	@Parameter(type = ItemIO.OUTPUT)
	private O out;

	public I getInput() {
		return in;
	}

	public O getOutput() {
		return out;
	}

	public void setInput(I input) {
		in = input;
	}

	public void setOutput(O output) {
		out = output;
	}

	public abstract O compute(I input, O output);

	@Override
	public void run() {
		compute(getInput(), getOutput());
	}

	@Override
	public abstract Function<I, O> copy();

}

/*
 * #%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;
import org.scijava.plugin.Parameter;

/**
 * A function (in this context) is an {@link Op} that has a typed input
 * parameter and a typed output parameter, which are accessible via its public
 * API ({@link #getInput()}, {@link #getOutput()}, etc.). It also possesses the
 * ability to copy itself via the {@link #copy} method. Lastly, it provides a
 * {@link #compute} method to compute the function for different input and
 * output parameters.
 * 
 * @author Christian Dietz
 * @author Martin Horn
 * @author Curtis Rueden
 */
public abstract class Function<I, O> implements Op, Copyable {

	@Parameter
	private I in;

	@Parameter(type = ItemIO.OUTPUT)
	private O out;

	public I getInput() {
		return in;
	}

	public O getOutput() {
		return out;
	}

	public void setInput(I input) {
		in = input;
	}

	public void setOutput(O output) {
		out = output;
	}

	public abstract O compute(I input, O output);

	@Override
	public void run() {
		compute(getInput(), getOutput());
	}

	@Override
	public abstract Function<I, O> copy();

}

add some javadoc