STK_Qr.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA

    Contact : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  Algebra
 * Purpose:  Define the Qr Class.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_QR_H
#define STK_QR_H

#include "../../Arrays/include/STK_Matrix.h"
#include "../../Arrays/include/STK_MatrixUpperTriangular.h"

namespace STK
{

class Qr
{
  protected :
    Matrix Q_;
    MatrixUpperTriangular R_;
    Integer  ncolr_;
    Integer  ncolq_;
    Integer  nrowq_;
    bool compq_;

  public :
    Qr( Matrix const&  A = Matrix(), bool ref = false);

    virtual ~Qr();

    Qr& operator=(const Qr &S);

    inline bool  isCompQ() const
    { return compq_;}
    inline Matrix const& Q() const  { return Q_;}
    inline const MatrixUpperTriangular& R() const { return R_;}

    void clear();

    void run();

    void compQ();

    void popBackCols(Integer const& n =1);

    void eraseCol(Integer const& pos);

    void pushBackCol(Vector const& T);

    void insertCol(Vector const& T, Integer const& pos);

    /* TODO : Delete the ith row and update the QR decomposition :
     *  default is the last row.
     **/    
    //Qr& popBackRows();
    //Qr& eraseRows(Integer i);

    /* TODO : Add a row with value T and update th QR decomposition :
     *  default is the last column position.
     **/
    //Qr& pushBackRows(const ArrayHo<double> &T);
    //Qr& insertRows(const ArrayHo<double> &T, Integer i);

  private:
    void qr();
};

} // Namespace STK

#endif
// STK_QR_H