Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
MathInvocationTransformer |
|
| 1.0;1 |
1 | /* | |
2 | * Licensed to the Apache Software Foundation (ASF) under one or more | |
3 | * contributor license agreements. See the NOTICE file distributed with | |
4 | * this work for additional information regarding copyright ownership. | |
5 | * The ASF licenses this file to You under the Apache License, Version 2.0 | |
6 | * (the "License"); you may not use this file except in compliance with | |
7 | * the License. You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.apache.org/licenses/LICENSE-2.0 | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | package org.apache.commons.nabla.automatic.functions; | |
18 | ||
19 | import org.apache.commons.nabla.automatic.analysis.MethodDifferentiator; | |
20 | import org.apache.commons.nabla.core.DifferentiationException; | |
21 | import org.objectweb.asm.tree.InsnList; | |
22 | ||
23 | /** Interface for replacing single math method invocations. | |
24 | */ | |
25 | public interface MathInvocationTransformer { | |
26 | ||
27 | /** Descriptor for <code>double m(double)</code> methods. */ | |
28 | String D_RETURN_D_DESCRIPTOR = "(D)D"; | |
29 | ||
30 | /** Descriptor for <code>double m(double, double)</code> methods. */ | |
31 | String DD_RETURN_D_DESCRIPTOR = "(DD)D"; | |
32 | ||
33 | /** Get the replacement list for an invocation instruction. | |
34 | * @param owner owner of the method (typically Math or StrictMath) | |
35 | * @param methodDifferentiator method differentiator driving this transformer | |
36 | * @return replacement list | |
37 | * @exception DifferentiationException if the method differentiator cannot provide | |
38 | * a temporary variable | |
39 | */ | |
40 | InsnList getReplacementList(String owner, MethodDifferentiator methodDifferentiator) | |
41 | throws DifferentiationException; | |
42 | ||
43 | } |