View Javadoc
1   /*
2    * Licensed to the Hipparchus project 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 Hipparchus project 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    *      https://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  
18  package org.hipparchus.linear;
19  
20  import org.hipparchus.FieldElement;
21  import org.hipparchus.exception.MathIllegalArgumentException;
22  
23  /** Interface for all algorithms providing matrix decomposition.
24   * @since 2.2
25   * @param <T> the type of the field elements
26   */
27  public interface FieldMatrixDecomposer<T extends FieldElement<T>> {
28  
29      /**
30       * Get a solver for finding the A &times; X = B solution in least square sense.
31       * @param a coefficient matrix A to decompose
32       * @return a solver
33       * @throws MathIllegalArgumentException if decomposition fails
34       */
35      FieldDecompositionSolver<T> decompose(FieldMatrix<T> a) throws MathIllegalArgumentException;
36  
37  }