001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.nabla.forward.analysis;
018    
019    import org.apache.commons.math3.analysis.differentiation.DerivativeStructure;
020    import org.apache.commons.nabla.DifferentiationException;
021    import org.objectweb.asm.Type;
022    import org.objectweb.asm.tree.AbstractInsnNode;
023    import org.objectweb.asm.tree.InsnList;
024    
025    /** Transformer for bytecode instructions.
026     * <p>Transformation is done by replacing a single instruction with
027     * a complete list.</p>
028     * @version $Id$
029     */
030    public interface InstructionsTransformer {
031    
032        /** Type for {@link DerivativeStructure}. */
033        Type DS_TYPE = Type.getType(DerivativeStructure.class);
034    
035        /** Get the replacement instructions.
036         * @param original original instruction
037         * @param methodDifferentiator method differentiator driving this transformer
038         * @return replacement instructions
039         * @exception DifferentiationException if the method differentiator cannot provide
040         * a temporary variable
041         */
042        InsnList getReplacement(AbstractInsnNode original,
043                                MethodDifferentiator methodDifferentiator)
044            throws DifferentiationException;
045    
046    }