/*

  * 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.arithmetic;

 import org.apache.commons.nabla.DifferentiationException;

 import org.apache.commons.nabla.forward.analysis.InstructionsTransformer;

 import org.apache.commons.nabla.forward.analysis.MethodDifferentiator;

 import org.objectweb.asm.Opcodes;

 import org.objectweb.asm.Type;

 import org.objectweb.asm.tree.AbstractInsnNode;

 import org.objectweb.asm.tree.InsnList;

 import org.objectweb.asm.tree.InsnNode;

 import org.objectweb.asm.tree.MethodInsnNode;

 import org.objectweb.asm.tree.VarInsnNode;

 /** Differentiation transformer for DREM instructions.

  * @version $Id$

  */

 public class DRemTransformer implements InstructionsTransformer {

     /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the remainder. */

     private static final String REMAINDER_METHOD = "remainder";

     /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the value getter. */

     private static final String VALUE_GETTER_METHOD = "getValue";

     /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the multiplication. */

     private static final String MULTIPLY_METHOD = "multiply";

     /** Name of the {@link org.apache.commons.math3.analysis.differentiation.DerivativeStructure} method corresponding to the addition. */

     private static final String ADD_METHOD = "add";

     /** Indicator for top stack element conversion. */

     private final boolean stack0Converted;

     /** Indicator for next to top stack element conversion. */

     private final boolean stack1Converted;

     /** Simple constructor.

      * @param stack0Converted if true, the top level stack element has already been converted

      * @param stack1Converted if true, the next to top level stack element has already been converted

      */

     public DRemTransformer(final boolean stack0Converted, final boolean stack1Converted) {

         this.stack0Converted = stack0Converted;

         this.stack1Converted = stack1Converted;

     }

     /** {@inheritDoc} */

     public InsnList getReplacement(final AbstractInsnNode insn,

                                    final MethodDifferentiator methodDifferentiator)

         throws DifferentiationException {

         final InsnList list = new InsnList();

         if (stack1Converted) {

             if (stack0Converted) {

                 list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),

                                             REMAINDER_METHOD,

                                             Type.getMethodDescriptor(DS_TYPE, DS_TYPE)));

             } else {

                 list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),

                                             REMAINDER_METHOD,

                                             Type.getMethodDescriptor(DS_TYPE, Type.DOUBLE_TYPE)));

             }

         } else {

             // set up a temporary variable

             final int tmp1 = methodDifferentiator.getTmp(1);

             // operand stack initial state: a, ds_b

             list.add(new InsnNode(Opcodes.DUP_X2));                                            // => ds_b, a, ds_b

             list.add(new InsnNode(Opcodes.POP));                                               // => ds_b, a

             list.add(new VarInsnNode(Opcodes.DSTORE, tmp1));                                   // => ds_b

             list.add(new InsnNode(Opcodes.DUP));                                               // => ds_b, ds_b

             list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),

                                         VALUE_GETTER_METHOD,

                                         Type.getMethodDescriptor(Type.DOUBLE_TYPE)));          // => ds_b, b0

             list.add(new InsnNode(Opcodes.DUP2));                                              // => ds_b, b0, b0

             list.add(new VarInsnNode(Opcodes.DLOAD,  tmp1));                                   // => ds_b, b0, b0, a

             list.add(new InsnNode(Opcodes.DUP2_X2));                                           // => ds_b, b0, a, b0, a

             list.add(new InsnNode(Opcodes.POP2));                                              // => ds_b, b0, a, b0

             list.add(new InsnNode(Opcodes.DREM));                                              // => ds_b, b0, a%b0

             list.add(new VarInsnNode(Opcodes.DLOAD,  tmp1));                                   // => ds_b, b0, a%b0, a

             list.add(new InsnNode(Opcodes.DSUB));                                              // => ds_b, b0, a%b0-a

             list.add(new InsnNode(Opcodes.DUP2_X2));                                           // => ds_b, a%b0-a, b0, a%b0-a

             list.add(new InsnNode(Opcodes.POP2));                                              // => ds_b, a%b0-a, b0

             list.add(new InsnNode(Opcodes.DDIV));                                              // => ds_b, q=(a%b0-a)/b0

             list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),

                                         MULTIPLY_METHOD,

                                         Type.getMethodDescriptor(DS_TYPE, Type.DOUBLE_TYPE))); // => q*b

             list.add(new VarInsnNode(Opcodes.DLOAD,  tmp1));                                   // => q*b, a

             list.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, DS_TYPE.getInternalName(),

                                         ADD_METHOD,

                                         Type.getMethodDescriptor(DS_TYPE, Type.DOUBLE_TYPE))); // => a+q*b

         }

         return list;

     }

 }