/*

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

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

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

 import org.objectweb.asm.tree.InsnList;

 /** Interface for replacing single math method invocations.

  */

 public interface MathInvocationTransformer {

     /** Descriptor for <code>double m(double)</code> methods. */

     String D_RETURN_D_DESCRIPTOR = "(D)D";

     /** Descriptor for <code>double m(double, double)</code> methods. */

     String DD_RETURN_D_DESCRIPTOR = "(DD)D";

     /** Get the replacement list for an invocation instruction.

      * @param owner owner of the method (typically Math or StrictMath)

      * @param methodDifferentiator method differentiator driving this transformer

      * @return replacement list

      * @exception DifferentiationException if the method differentiator cannot provide

      * a temporary variable

      */

     InsnList getReplacementList(String owner, MethodDifferentiator methodDifferentiator)

         throws DifferentiationException;

 }