org.scijava.ops.engine.matcher.reduce.ReducedOpInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-ops-engine Show documentation
Java implementation of the SciJava Ops matching engine.
The newest version!
/*-
 * #%L
 * Java implementation of the SciJava Ops matching engine.
 * %%
 * Copyright (C) 2016 - 2024 SciJava developers.
 * %%
 * 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 org.scijava.ops.engine.matcher.reduce;

import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;

import org.scijava.ops.api.Hints;
import org.scijava.ops.api.OpInfo;
import org.scijava.ops.engine.BaseOpHints;
import org.scijava.ops.engine.struct.FunctionalMethodType;
import org.scijava.ops.engine.struct.OpResizingMemberParser;
import org.scijava.ops.engine.struct.RetypingRequest;
import org.scijava.ops.engine.util.Infos;
import org.scijava.struct.Member;
import org.scijava.struct.Struct;
import org.scijava.struct.StructInstance;
import org.scijava.struct.Structs;

public class ReducedOpInfo implements OpInfo {

	protected static final String IMPL_DECLARATION = "|Reduction:";
	protected static final String PARAMS_REDUCED = "|ParamsReduced:";
	protected static final String ORIGINAL_INFO = "|OriginalInfo:";

	private final OpInfo srcInfo;
	private final Type reducedOpType;
	private final int paramsReduced;

	private final Hints hints;
	private final Struct struct;

	public ReducedOpInfo(OpInfo src, Type reducedOpType, int paramsReduced) {
		this.srcInfo = src;
		this.reducedOpType = reducedOpType;
		this.paramsReduced = paramsReduced;
		this.hints = srcInfo.declaredHints().plus(BaseOpHints.Reduction.FORBIDDEN);

		RetypingRequest r = retypingRequest();
		this.struct = Structs.from(r, reducedOpType, new OpResizingMemberParser());
	}

	/**
	 * For an Op with n inputs and one output (which may also be an input), we
	 * want to preserve n-paramsReduced inputs and that one output. This retyping
	 * request will preserve ONLY those inputs. Finding those inputs in the struct
	 * of {@code srcInfo}, though, is tricky because the output could appear
	 * anywhere in that {@link Struct} (thanks Inplaces :P). So, we split this
	 * problem into two subproblems:
	 * 
	 * When the output is also an input
	 * When the output is not an input
	 * 
	 *
	 * @return a {@link RetypingRequest} defining how to create the {@link Struct}
	 *         of this {@link ReducedOpInfo}
	 */
	private RetypingRequest retypingRequest() {
		if (srcInfo.output().isInput()) {
			return mutableOutputOpRetypingRequest();
		}
		return pureOutputOpRetypingRequest();
	}

	/**
	 * For an Op with n inputs and one mutable output, we want to retain
	 * the mutable output (wherever it is in the {@link Struct}), as well as the
	 * first {@code n-paramsReduced-1} pure inputs.
	 *
	 * @return a {@link RetypingRequest} defining how to create the {@link Struct}
	 *         of this {@link ReducedOpInfo}
	 */
	private RetypingRequest mutableOutputOpRetypingRequest() {
		List> inputs = srcInfo.inputs();
		// We need n - paramsReduced - 1 pure inputs
		int retainedPureInputs = inputs.size() - paramsReduced - 1;
		List newFmts = new ArrayList<>();
		int addedPureInputs = 0;
		for (Member m : srcInfo.inputs()) {
			// if pure input, add only if we haven't added enough pure inputs
			if (!m.isOutput() && addedPureInputs < retainedPureInputs) {
				newFmts.add(new FunctionalMethodType(m));
				addedPureInputs++;
			}
			// if I/O output, add it
			else if (m.isOutput()) {
				newFmts.add(new FunctionalMethodType(m));
			}
		}

		return new RetypingRequest(srcInfo.struct(), newFmts);
	}

	/**
	 * For an Op with n inputs and one pure output, we want to retain the
	 * first {@code n-paramsReduced} pure inputs as well as that pure
	 * output.
	 *
	 * @return a {@link RetypingRequest} defining how to create the {@link Struct}
	 *         of this {@link ReducedOpInfo}
	 */
	private RetypingRequest pureOutputOpRetypingRequest() {
		List> inputs = srcInfo.inputs();
		// Of the n inputs in srcInfo, we need to keep n-paramsReduced of them.
		long retainedPureInputs = inputs.size() - paramsReduced;
		List newFmts = inputs.stream() //
			.limit(retainedPureInputs) //
			.map(FunctionalMethodType::new) //
			.collect(Collectors.toList());
		// Grab the pure output, and tack it onto the end.
		newFmts.add(new FunctionalMethodType(srcInfo.output()));
		return new RetypingRequest(srcInfo.struct(), newFmts);
	}

	@Override
	public Type opType() {
		return reducedOpType;
	}

	@Override
	public Struct struct() {
		return struct;
	}

	@Override
	public Hints declaredHints() {
		return hints;
	}

	@Override
	public List names() {
		return srcInfo.names();
	}

	@Override
	public String description() {
		return srcInfo.description();
	}

	@Override
	public double priority() {
		return srcInfo.priority();
	}

	@Override
	public String implementationName() {
		// TODO: improve this name
		return srcInfo.implementationName() + "Reduction" + paramsReduced;
	}

	@Override
	public StructInstance createOpInstance(List dependencies) {
		final Object op = srcInfo.createOpInstance(dependencies).object();
		try {
			Object reducedOp = ReductionUtils.javassistOp(op, this);
			return struct().createInstance(reducedOp);
		}
		catch (Throwable ex) {
			throw new IllegalArgumentException(
				"Failed to invoke reduction of Op: \n" + srcInfo +
					"\nProvided Op dependencies were: " + Objects.toString(dependencies),
				ex);
		}
	}

	@Override
	public AnnotatedElement getAnnotationBearer() {
		return srcInfo.getAnnotationBearer();
	}

	@Override
	public String version() {
		return srcInfo().version();
	}

	/**
	 * For a reduced Op, we define the implementation as the concatenation of:
	 * 
	 * The number of reduced parameters
	 * 
The id of the source Op
	 * 
	 * 
	 */
	@Override
	public String id() {
		// declaration
		StringBuilder sb = new StringBuilder(IMPL_DECLARATION);
		// params reduced
		sb.append(PARAMS_REDUCED);
		sb.append(paramsReduced());
		// original info
		sb.append(ORIGINAL_INFO);
		sb.append(srcInfo().id());
		return sb.toString();
	}

	public OpInfo srcInfo() {
		return srcInfo;
	}

	public int paramsReduced() {
		return paramsReduced;
	}

	@Override
	public String toString() {
		return Infos.describe(this);
	}

}