View Javadoc
1   /*
2    * Copyright (C) 2023 Alberto Irurueta Carro (alberto@irurueta.com)
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *         http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package com.irurueta.numerical.integration;
17  
18  import com.irurueta.algebra.Matrix;
19  import com.irurueta.numerical.EvaluationException;
20  
21  /**
22   * Interface to define how matrix (multivariate) single dimension functions can be evaluated in
23   * Double Exponential Rule Quadrature function integrators.
24   */
25  public interface DoubleExponentialMatrixSingleDimensionFunctionEvaluatorListener {
26  
27      /**
28       * Evaluates a single dimension function such as f(x) at provided point and returns the result.
29       *
30       * @param x      point where function will be evaluated.
31       * @param delta  value to handle singularities. If the function has no singularities, or the
32       *               singularities are “mild” (e.g., no worse than logarithmic), this can be ignored.
33       * @param result matrix where function evaluation will be stored.
34       * @throws EvaluationException raised if something failed during the evaluation.
35       */
36      void evaluate(final double x, final double delta, final Matrix result) throws EvaluationException;
37  
38      /**
39       * Gets number of rows of matrix result of function f.
40       *
41       * @return number of rows.
42       */
43      int getRows();
44  
45      /**
46       * Gets number of columns of matrix result of function f.
47       *
48       * @return number of columns.
49       */
50      int getColumns();
51  }