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 /** Matrix decomposer using LU-decomposition.
21 * @since 1.3
22 */
23 public class LUDecomposer implements MatrixDecomposer {
24
25 /** Threshold under which a matrix is considered singular. */
26 private final double singularityThreshold;
27
28 /**
29 * Creates a LU decomposer with specify threshold for several matrices.
30 * @param singularityThreshold threshold (based on partial row norm)
31 * under which a matrix is considered singular
32 */
33 public LUDecomposer(final double singularityThreshold) {
34 this.singularityThreshold = singularityThreshold;
35 }
36
37 /** {@inheritDoc} */
38 @Override
39 public DecompositionSolver decompose(final RealMatrix a) {
40 return new LUDecomposition(a, singularityThreshold).getSolver();
41 }
42
43 }