summaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java
diff options
context:
space:
mode:
authorKarl Shaffer <karlshaffer@google.com>2023-08-09 18:06:31 -0700
committerKarl Shaffer <karlshaffer@google.com>2023-08-09 18:08:02 -0700
commit1354beaf452fc42c23c82fc80d2f2e9ffcbf3688 (patch)
treeace24ba4307d4978ee3134f7da671a77ad172da0 /src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java
parent122880aa37838deafdd5a68fe19cdaa856ce243a (diff)
downloadapache-commons-math-1354beaf452fc42c23c82fc80d2f2e9ffcbf3688.tar.gz
Check-in commons-math 3.6.1
This includes many changes over the original version and is also incompatible, which is why the existing commons-math library is left untouched. Test: N/A Change-Id: Icd0f3069a3c62b2572f2263732d91e6c3b6e8cba
Diffstat (limited to 'src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java')
-rw-r--r--src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java40
1 files changed, 40 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java b/src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java
new file mode 100644
index 0000000..b31771b
--- /dev/null
+++ b/src/main/java/org/apache/commons/math3/analysis/differentiation/UnivariateDifferentiableMatrixFunction.java
@@ -0,0 +1,40 @@
+/*
+ * 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.math3.analysis.differentiation;
+
+import org.apache.commons.math3.analysis.UnivariateMatrixFunction;
+import org.apache.commons.math3.exception.MathIllegalArgumentException;
+
+/**
+ * Extension of {@link UnivariateMatrixFunction} representing a univariate differentiable matrix function.
+ *
+ * @since 3.1
+ */
+public interface UnivariateDifferentiableMatrixFunction
+ extends UnivariateMatrixFunction {
+
+ /**
+ * Compute the value for the function.
+ * @param x the point for which the function value should be computed
+ * @return the value
+ * @exception MathIllegalArgumentException if {@code x} does not
+ * satisfy the function's constraints (argument out of bound, or unsupported
+ * derivative order for example)
+ */
+ DerivativeStructure[][] value(DerivativeStructure x) throws MathIllegalArgumentException;
+
+}