Tsqr_Combine.hpp

// @HEADER
// ***********************************************************************
//
//                 Anasazi: Block Eigensolvers Package
//                 Copyright (2010) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library 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.1 of the
// License, or (at your option) any later version.
//
// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef __TSQR_Combine_hpp
#define __TSQR_Combine_hpp

#include <Tsqr_ApplyType.hpp>
#include <Tsqr_MatView.hpp>
#include <Tsqr_ScalarTraits.hpp>
#include <Tsqr_CombineNative.hpp>


namespace TSQR {

  template< class Ordinal, 
      class Scalar, 
      class CombineImpl = CombineNative< Ordinal, Scalar, ScalarTraits< Scalar >::is_complex > >
  class Combine {
  public:
    typedef Scalar scalar_type;
    typedef Ordinal ordinal_type;
    typedef CombineImpl combine_impl_type;

    Combine () {}

    static bool QR_produces_R_factor_with_nonnegative_diagonal() {
      return combine_impl_type::QR_produces_R_factor_with_nonnegative_diagonal();
    }

    void
    factor_first (const Ordinal nrows,
      const Ordinal ncols,
      Scalar A[],
      const Ordinal lda,
      Scalar tau[],
      Scalar work[]) const
    {
      return impl_.factor_first (nrows, ncols, A, lda, tau, work);
    }

    void
    apply_first (const ApplyType& applyType,
     const Ordinal nrows,
     const Ordinal ncols_C,
     const Ordinal ncols_A,
     const Scalar A[],
     const Ordinal lda,
     const Scalar tau[],
     Scalar C[],
     const Ordinal ldc,
     Scalar work[]) const
    {
      return impl_.apply_first (applyType, nrows, ncols_C, ncols_A, 
        A, lda, tau, C, ldc, work);
    }

    void
    apply_inner (const ApplyType& apply_type,
     const Ordinal m,
     const Ordinal ncols_C,
     const Ordinal ncols_Q,
     const Scalar A[],
     const Ordinal lda,
     const Scalar tau[],
     Scalar C_top[],
     const Ordinal ldc_top,
     Scalar C_bot[],
     const Ordinal ldc_bot,
     Scalar work[]) const
    {
      impl_.apply_inner (apply_type, m, ncols_C, ncols_Q, 
       A, lda, tau, 
       C_top, ldc_top, C_bot, ldc_bot, work);
    }

    void
    factor_inner (const Ordinal m,
      const Ordinal n,
      Scalar R[],
      const Ordinal ldr,
      Scalar A[],
      const Ordinal lda,
      Scalar tau[],
      Scalar work[]) const
    {
      impl_.factor_inner (m, n, R, ldr, A, lda, tau, work);
    }

    void
    factor_pair (const Ordinal n,
     Scalar R_top[],
     const Ordinal ldr_top,
     Scalar R_bot[],
     const Ordinal ldr_bot,
     Scalar tau[],
     Scalar work[]) const
    {
      impl_.factor_pair (n, R_top, ldr_top, R_bot, ldr_bot, tau, work);      
    }
    
    void
    apply_pair (const ApplyType& apply_type,
    const Ordinal ncols_C, 
    const Ordinal ncols_Q, 
    const Scalar R_bot[], 
    const Ordinal ldr_bot,
    const Scalar tau[], 
    Scalar C_top[], 
    const Ordinal ldc_top, 
    Scalar C_bot[], 
    const Ordinal ldc_bot, 
    Scalar work[]) const
    {
      impl_.apply_pair (apply_type, ncols_C, ncols_Q, 
      R_bot, ldr_bot, tau, 
      C_top, ldc_top, C_bot, ldc_bot, work);
    }

  private:
    combine_impl_type impl_;
  };

} // namespace TSQR

#endif // __TSQR_Combine_hpp