/*

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

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

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

 import org.apache.commons.nabla.core.DifferentiationException;

 import org.objectweb.asm.Opcodes;

 import org.objectweb.asm.tree.AbstractInsnNode;

 import org.objectweb.asm.tree.InsnList;

 import org.objectweb.asm.tree.InsnNode;

 import org.objectweb.asm.tree.VarInsnNode;

 /** Differentiation transformer for DREM instructions.

  * <p>This transformer is used when only the second argument

  * of DREM is an expanded differential pair. It is based on

  * the identity: <code>a%b = a - q * b</code> where q is an

  * integer.</p>

  * @see DRemTransformer1

  * @see DRemTransformer12

  */

 public class DRemTransformer12 implements InstructionsTransformer {

     /** Holder for the singleton instance.*/

     private static class LazyHolder  {

         /** The singleton instance. */

         private static final InstructionsTransformer INSTANCE = new DRemTransformer12();

     }

     /** Hidden constructor.

      */

     private DRemTransformer12() {

     }

     /** Get the singleton instance.

      * <p>We use here the Initialization on Demand Holder idiom.</p>

      * @return the singleton instance

      */

     public static InstructionsTransformer getInstance() {

         return LazyHolder.INSTANCE;

     }

     /** {@inheritDoc} */

     public InsnList getReplacement(final AbstractInsnNode insn,

                                    final MethodDifferentiator methodDifferentiator)

         throws DifferentiationException {

         final int tmp1 = methodDifferentiator.getTmp(1);

         final int tmp2 = methodDifferentiator.getTmp(2);

         final int tmp3 = methodDifferentiator.getTmp(3);

         final int tmp4 = methodDifferentiator.getTmp(4);

         final InsnList list = new InsnList();

         // operand stack initial state: a0, a1, b0, b1

         list.add(new VarInsnNode(Opcodes.DSTORE, tmp1)); // => a0, a1, b0

         list.add(new VarInsnNode(Opcodes.DSTORE, tmp2)); // => a0, a1

         list.add(new VarInsnNode(Opcodes.DSTORE, tmp3)); // => a0

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

         list.add(new VarInsnNode(Opcodes.DLOAD,  tmp4)); // => a0

         list.add(new VarInsnNode(Opcodes.DLOAD,  tmp2)); // => a0, b0

         list.add(new InsnNode(Opcodes.DREM));            // => a0%b0

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

         list.add(new VarInsnNode(Opcodes.DLOAD,  tmp4)); // => a0%b0, a0%b0, a0

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

         list.add(new VarInsnNode(Opcodes.DLOAD,  tmp2)); // => a0%b0, a0%b0-a0, b0

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

         list.add(new VarInsnNode(Opcodes.DLOAD,  tmp1)); // => a0%b0, -q, b1

         list.add(new InsnNode(Opcodes.DMUL));            // => a0%b0, -q*b1

         list.add(new VarInsnNode(Opcodes.DLOAD,  tmp3)); // => a0%b0, -q*b1, a1

         list.add(new InsnNode(Opcodes.DADD));            // => a0%b0, a1-q*b1

         return list;

     }

 }