/*

  * Licensed to the Apache Software Foundation (ASF) under one or more

  * contributor license agreements.  See the NOTICE file distributed with

  * this work for additional information regarding copyright ownership.

  * The ASF licenses this file to You 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 org.apache.commons.nabla.forward.analysis;

 import org.apache.commons.math3.analysis.differentiation.DerivativeStructure;

 import org.apache.commons.nabla.DifferentiationException;

 import org.objectweb.asm.Type;

 import org.objectweb.asm.tree.AbstractInsnNode;

 import org.objectweb.asm.tree.InsnList;

 /** Transformer for bytecode instructions.

  * <p>Transformation is done by replacing a single instruction with

  * a complete list.</p>

  * @version $Id$

  */

 public interface InstructionsTransformer {

     /** Type for {@link DerivativeStructure}. */

     Type DS_TYPE = Type.getType(DerivativeStructure.class);

     /** Get the replacement instructions.

      * @param original original instruction

      * @param methodDifferentiator method differentiator driving this transformer

      * @return replacement instructions

      * @exception DifferentiationException if the method differentiator cannot provide

      * a temporary variable

      */

     InsnList getReplacement(AbstractInsnNode original,

                             MethodDifferentiator methodDifferentiator)

         throws DifferentiationException;

 }