src/java/org/apache/commons/math/linear/QRDecomposition.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.math.linear;

/**
 * An interface to classes that implement a algorithm to calculate the 
 * QR-decomposition of a real matrix.
 *   
 * @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
 * @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a>
 * @version $Revision$ $Date$
 * @since 1.2
 */
public interface QRDecomposition {

    /**
     * Returns the matrix R of the decomposition. 
     * 
     * @return the R matrix
     */
    public abstract RealMatrix getR();

    /**
     * Returns the matrix Q of the decomposition.
     * 
     * @return the Q matrix
     */
    public abstract RealMatrix getQ();
}