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.CalculusFieldElement;
21
22 /** Matrix decomposer using QR-decomposition.
23 * @param <T> the type of the field elements
24 * @since 2.2
25 */
26 public class FieldQRDecomposer<T extends CalculusFieldElement<T>> implements FieldMatrixDecomposer<T> {
27
28 /** Threshold under which a matrix is considered singular. */
29 private final T singularityThreshold;
30
31 /**
32 * Creates a QR decomposer with specify threshold for several matrices.
33 * @param singularityThreshold threshold (based on partial row norm)
34 * under which a matrix is considered singular
35 */
36 public FieldQRDecomposer(final T singularityThreshold) {
37 this.singularityThreshold = singularityThreshold;
38 }
39
40 /** {@inheritDoc} */
41 @Override
42 public FieldDecompositionSolver<T> decompose(final FieldMatrix<T> a) {
43 return new FieldQRDecomposition<>(a, singularityThreshold).getSolver();
44 }
45
46 }