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 java.util.function.Predicate;
21  
22  import org.hipparchus.FieldElement;
23  
24  /** Matrix decomposer using LU-decomposition.
25   * @param <T> the type of the field elements
26   * @since 2.2
27   */
28  public class FieldLUDecomposer<T extends FieldElement<T>> implements FieldMatrixDecomposer<T> {
29  
30      /** Checker for zero elements. */
31      private final Predicate<T> zeroChecker;
32  
33      /**
34       * Creates a LU decomposer with specific zero checker for several matrices.
35       * @param zeroChecker checker for zero elements
36       */
37      public FieldLUDecomposer(final Predicate<T> zeroChecker) {
38          this.zeroChecker = zeroChecker;
39      }
40  
41      /** {@inheritDoc} */
42      @Override
43      public FieldDecompositionSolver<T> decompose(final FieldMatrix<T> a) {
44          return new FieldLUDecomposition<>(a, zeroChecker).getSolver();
45      }
46  
47  }