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.
23   */
24  public interface MatrixSingleDimensionFunctionEvaluatorListener {
25      /**
26       * Evaluates a matrix function such as f(x1) at provided point and returns the result as a
27       * matrix.
28       *
29       * @param point  point where function will be evaluated.
30       * @param result matrix where function evaluation will be stored.
31       * @throws EvaluationException if something failed during the evaluation.
32       */
33      void evaluate(final double point, final Matrix result) throws EvaluationException;
34  
35      /**
36       * Gets number of rows of matrix result of function f.
37       *
38       * @return number of rows.
39       */
40      int getRows();
41  
42      /**
43       * Gets number of columns of matrix result of function f.
44       *
45       * @return number of columns.
46       */
47      int getColumns();
48  }