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  /** Matrix decomposer using Singular Value Decomposition.
21   * @since 1.3
22   */
23  public class SingularValueDecomposer implements MatrixDecomposer {
24  
25      /** Empty constructor.
26       * <p>
27       * This constructor is not strictly necessary, but it prevents spurious
28       * javadoc warnings with JDK 18 and later.
29       * </p>
30       * @since 3.0
31       */
32      public SingularValueDecomposer() { // NOPMD - unnecessary constructor added intentionally to make javadoc happy
33          // nothing to do
34      }
35  
36      /** {@inheritDoc} */
37      @Override
38      public DecompositionSolver decompose(final RealMatrix a) {
39          return new SingularValueDecomposition(a).getSolver();
40      }
41  
42  }