DenseLinAlgPack_DMatrixAsTriSym.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef GEN_MATRIX_AS_TRI_SYM_H
#define GEN_MATRIX_AS_TRI_SYM_H

#include "DenseLinAlgPack_DMatrixClass.hpp"

namespace DenseLinAlgPack {

/* * @name  Packaging arguments for GenMatrixSlices treated as triangular
  *     and symmetric matrices in BLAS-like linear algebra operations.
  *
  */

// @{

// /////////////////////////////////////////////////////////////////////////////////////
/* * Aggregate information for a triangular matrix (element-wise) stored in a DMatrix.
  *
  * This is the type to be used as lhs and rhs arguments in element-wise
  * linear algebra operations like assignment and binary arithmetic.
  */
class DMatrixSliceTriEle {
public:
  DMatrixSliceTriEle(const DMatrixSlice& gms, BLAS_Cpp::Uplo uplo)
    : gms_(const_cast<DMatrixSlice&>(gms)), uplo_(uplo)
  {
    #ifdef LINALGPACK_CHECK_RHS_SIZES
      assert_gms_square(gms);
    #endif
  }
  size_type rows() const {
    return gms_.rows();
  }
  size_type cols() const {
    return gms_.cols();
  }
  DMatrixSlice& gms() {
    return gms_;
  }
  const DMatrixSlice& gms() const {
    return gms_;
  }
  BLAS_Cpp::Uplo  uplo() const {
    return uplo_;
  }
  DMatrixSliceTriEle* operator&() {
    return this;
  }
  const DMatrixSliceTriEle* operator&() const {
    return this;
  }

private:  
  DMatrixSlice  gms_;
  BLAS_Cpp::Uplo  uplo_;
  // Not defined and not to be called
  DMatrixSliceTriEle();
  DMatrixSliceTriEle& operator=(const DMatrixSliceTriEle&);
};  // end class DMatrixSliceTriEle

inline
DMatrixSliceTriEle nonconst_tri_ele(DMatrixSlice gms, BLAS_Cpp::Uplo uplo)
{
  return DMatrixSliceTriEle(gms, uplo);
}

inline
const DMatrixSliceTriEle tri_ele(const DMatrixSlice& gms, BLAS_Cpp::Uplo uplo)
{
  return DMatrixSliceTriEle(gms, uplo);
}

// ////////////////////////////////////////////////////////////////////////////////
/* * Aggregate information for a triangular matrix (structure dependent) stored in a DMatrix.
  *
  * This is the type to be used as a rhs argument in linear algebra operations
  * that are structure specific like the BLAS operations.
  */
class DMatrixSliceTri {
public:
  DMatrixSliceTri(const DMatrixSlice& gms, BLAS_Cpp::Uplo uplo, BLAS_Cpp::Diag diag)
    : gms_(const_cast<DMatrixSlice&>(gms)), uplo_(uplo), diag_(diag)
  {
    #ifdef LINALGPACK_CHECK_RHS_SIZES
      assert_gms_square(gms);
    #endif
  }
  size_type rows() const {
    return gms_.rows();
  }
  size_type cols() const {
    return gms_.cols();
  }
  DMatrixSlice& gms() {
    return gms_;
  }
  const DMatrixSlice& gms() const {
    return gms_;
  }
  BLAS_Cpp::Uplo  uplo() const {
    return uplo_;
  }
  BLAS_Cpp::Diag  diag() const {
    return diag_;
  }
  DMatrixSliceTri* operator&() {
    return this;
  }
  const DMatrixSliceTri* operator&() const {
    return this;
  }

private:  
  DMatrixSlice  gms_;
  BLAS_Cpp::Uplo  uplo_;
  BLAS_Cpp::Diag  diag_;
  // not defined and not to be called
  DMatrixSliceTri();
  DMatrixSliceTri& operator=(const DMatrixSliceTri&);
};  // end class DMatrixSliceTri

inline
DMatrixSliceTri nonconst_tri(DMatrixSlice gms, BLAS_Cpp::Uplo uplo, BLAS_Cpp::Diag diag)
{
  return DMatrixSliceTri(gms, uplo, diag);
}

inline
const DMatrixSliceTri tri(const DMatrixSlice& gms, BLAS_Cpp::Uplo uplo, BLAS_Cpp::Diag diag)
{
  return DMatrixSliceTri(gms, uplo, diag);
}

// /////////////////////////////////////////////////////////////////////////////////////////
/* * Aggregate information for a symmetric matrix stored in a DMatrix.
  *
  * This is the type to be used as both lhs and rhs arguments in linear algebra operations.
  */
class DMatrixSliceSym {
public:
  DMatrixSliceSym(const DMatrixSlice& gms, BLAS_Cpp::Uplo uplo)
    : gms_(const_cast<DMatrixSlice&>(gms)), uplo_(uplo)
  {
    #ifdef LINALGPACK_CHECK_RHS_SIZES
      assert_gms_square(gms);
    #endif
  }
  size_type rows() const {
    return gms_.rows();
  }
  size_type cols() const {
    return gms_.cols();
  }
  DMatrixSlice& gms() {
    return gms_;
  }
  const DMatrixSlice& gms() const {
    return gms_;
  }
  BLAS_Cpp::Uplo  uplo() const {
    return uplo_;
  }
  DMatrixSliceSym* operator&() {
    return this;
  }
  const DMatrixSliceSym* operator&() const {
    return this;
  }

private:  
  DMatrixSlice  gms_;
  BLAS_Cpp::Uplo  uplo_;
  // not defined and not to be called
  DMatrixSliceSym();
  DMatrixSliceSym& operator=(const DMatrixSliceTri&);
};  // end class DMatrixSliceSym

inline
DMatrixSliceSym nonconst_sym(DMatrixSlice gms, BLAS_Cpp::Uplo uplo)
{
  return DMatrixSliceSym(gms, uplo);
}

inline
const DMatrixSliceSym sym(const DMatrixSlice& gms, BLAS_Cpp::Uplo uplo)
{
  return DMatrixSliceSym(gms, uplo);
}

// @}

} // end namespace DenseLinAlgPack

#endif  // GEN_MATRIX_AS_TRI_SYM_H