1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.nabla.forward.analysis;
18
19 import org.apache.commons.math3.analysis.differentiation.DerivativeStructure;
20 import org.apache.commons.nabla.DifferentiationException;
21 import org.objectweb.asm.Type;
22 import org.objectweb.asm.tree.AbstractInsnNode;
23 import org.objectweb.asm.tree.InsnList;
24
25 /** Transformer for bytecode instructions.
26 * <p>Transformation is done by replacing a single instruction with
27 * a complete list.</p>
28 * @version $Id$
29 */
30 public interface InstructionsTransformer {
31
32 /** Type for {@link DerivativeStructure}. */
33 Type DS_TYPE = Type.getType(DerivativeStructure.class);
34
35 /** Get the replacement instructions.
36 * @param original original instruction
37 * @param methodDifferentiator method differentiator driving this transformer
38 * @return replacement instructions
39 * @exception DifferentiationException if the method differentiator cannot provide
40 * a temporary variable
41 */
42 InsnList getReplacement(AbstractInsnNode original,
43 MethodDifferentiator methodDifferentiator)
44 throws DifferentiationException;
45
46 }