View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) 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 ASF 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    *      http://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.apache.commons.math.linear;
19  
20  /**
21   * An interface to classes that implement a algorithm to calculate the 
22   * QR-decomposition of a real matrix.
23   *   
24   * @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
25   * @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a>
26   * @version $Revision: 620312 $ $Date: 2008-02-10 12:28:59 -0700 (Sun, 10 Feb 2008) $
27   * @since 1.2
28   */
29  public interface QRDecomposition {
30  
31      /**
32       * Returns the matrix R of the decomposition. 
33       * 
34       * @return the R matrix
35       */
36      public abstract RealMatrix getR();
37  
38      /**
39       * Returns the matrix Q of the decomposition.
40       * 
41       * @return the Q matrix
42       */
43      public abstract RealMatrix getQ();
44  }