001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.nabla.forward.instructions;
018    
019    import org.apache.commons.nabla.DifferentiationException;
020    import org.apache.commons.nabla.forward.analysis.InstructionsTransformer;
021    import org.apache.commons.nabla.forward.analysis.MethodDifferentiator;
022    import org.objectweb.asm.Opcodes;
023    import org.objectweb.asm.tree.AbstractInsnNode;
024    import org.objectweb.asm.tree.InsnList;
025    import org.objectweb.asm.tree.InsnNode;
026    
027    /** Differentiation transformer for DRETURN instructions.
028     * <p>DRETURN instructions are replaced by ARETURN instructions
029     * as a reference to a {@link
030     * org.apache.commons.math3.analysis.differentiation.DerivativeStructure}
031     * instance uses only one stack slot instead of two.</p>
032     * @version $Id$
033     */
034    public class DReturnTransformer implements InstructionsTransformer {
035    
036        /** Indicator for top stack element conversion. */
037        private final boolean stack0Converted;
038    
039        /** Simple constructor.
040         * @param stack0Converted if true, the top level stack element has already been converted
041         */
042        public DReturnTransformer(final boolean stack0Converted) {
043            this.stack0Converted = stack0Converted;
044        }
045    
046        /** {@inheritDoc} */
047        public InsnList getReplacement(final AbstractInsnNode insn,
048                                       final MethodDifferentiator methodDifferentiator)
049            throws DifferentiationException {
050    
051            final InsnList list = new InsnList();
052    
053            if (!stack0Converted) {
054                // add conversion for top level stack element
055                list.add(methodDifferentiator.doubleToDerivativeStructureConversion());
056            }
057    
058            // add the return instruction for a reference type
059            list.add(new InsnNode(Opcodes.ARETURN));
060    
061            return list;
062    
063        }
064    
065    }