View Javadoc

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.arithmetic;
18  
19  import org.apache.commons.nabla.DifferentiationException;
20  import org.apache.commons.nabla.forward.analysis.InstructionsTransformer;
21  import org.apache.commons.nabla.forward.analysis.MethodDifferentiator;
22  import org.objectweb.asm.Opcodes;
23  import org.objectweb.asm.Type;
24  import org.objectweb.asm.tree.AbstractInsnNode;
25  import org.objectweb.asm.tree.InsnList;
26  import org.objectweb.asm.tree.InsnNode;
27  import org.objectweb.asm.tree.MethodInsnNode;
28  
29  /** Differentiation transformer for DDIV instructions.
30   * @version $Id$
31   */
32  public class DDivTransformer implements InstructionsTransformer {
33  
34      /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the division. */
35      private static final String DIVIDE_METHOD = "divide";
36  
37      /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the reciproval. */
38      private static final String RECIPROCAL_METHOD = "reciprocal";
39  
40      /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the multiplication. */
41      private static final String MULTIPLY_METHOD = "multiply";
42  
43      /** Indicator for top stack element conversion. */
44      private final boolean stack0Converted;
45  
46      /** Indicator for next to top stack element conversion. */
47      private final boolean stack1Converted;
48  
49      /** Simple constructor.
50       * @param stack0Converted if true, the top level stack element has already been converted
51       * @param stack1Converted if true, the next to top level stack element has already been converted
52       */
53      public DDivTransformer(final boolean stack0Converted, final boolean stack1Converted) {
54          this.stack0Converted = stack0Converted;
55          this.stack1Converted = stack1Converted;
56      }
57  
58      /** {@inheritDoc} */
59      public InsnList getReplacement(final AbstractInsnNode insn,
60                                     final MethodDifferentiator methodDifferentiator)
61          throws DifferentiationException {
62  
63          final InsnList list = new InsnList();
64  
65          if (stack1Converted) {
66              if (stack0Converted) {
67                  list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),
68                                              DIVIDE_METHOD,
69                                              Type.getMethodDescriptor(DS_TYPE, DS_TYPE)));
70              } else {
71                  list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),
72                                              DIVIDE_METHOD,
73                                              Type.getMethodDescriptor(DS_TYPE, Type.DOUBLE_TYPE)));
74              }
75          } else {
76              list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),
77                                          RECIPROCAL_METHOD,
78                                          Type.getMethodDescriptor(DS_TYPE)));
79              list.add(new InsnNode(Opcodes.DUP_X2));
80              list.add(new InsnNode(Opcodes.POP));
81              list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),
82                                          MULTIPLY_METHOD,
83                                          Type.getMethodDescriptor(DS_TYPE, Type.DOUBLE_TYPE)));
84          }
85  
86          return list;
87  
88      }
89  
90  }