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.algorithmic.forward.functions; 018 019 import org.apache.commons.nabla.algorithmic.forward.analysis.MethodDifferentiator; 020 import org.apache.commons.nabla.core.DifferentiationException; 021 import org.objectweb.asm.tree.InsnList; 022 023 /** Interface for replacing single math method invocations. 024 */ 025 public interface MathInvocationTransformer { 026 027 /** Descriptor for <code>double m(double)</code> methods. */ 028 String D_RETURN_D_DESCRIPTOR = "(D)D"; 029 030 /** Descriptor for <code>double m(double, double)</code> methods. */ 031 String DD_RETURN_D_DESCRIPTOR = "(DD)D"; 032 033 /** Get the replacement list for an invocation instruction. 034 * @param owner owner of the method (typically Math or StrictMath) 035 * @param methodDifferentiator method differentiator driving this transformer 036 * @return replacement list 037 * @exception DifferentiationException if the method differentiator cannot provide 038 * a temporary variable 039 */ 040 InsnList getReplacementList(String owner, MethodDifferentiator methodDifferentiator) 041 throws DifferentiationException; 042 043 }