DenseLinAlgPack_AssertOp.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 LIN_ALG_PACK_ASSERT_OP_H
#define LIN_ALG_PACK_ASSERT_OP_H

#include "DenseLinAlgPack_Types.hpp"

namespace DenseLinAlgPack {

#ifdef LINALGPACK_CHECK_RHS_SIZES


/* * @name Assertion functions for linear algebra operations.
  *
  * These functions check the sizes of the linear algebra
  * expressions and throw a std::length_error if
  * the sizes do not match.  These functions
  * only perform there operations if #LINALGPACK_CHECK_RHS_SIZES#
  * is defined.
  */
// @{

/* * @name Level 1 BLAS
  */
// @{

void Vp_V_assert_sizes(size_type v_lhs_size, size_type v_rhs_size);

void VopV_assert_sizes(size_type v_rhs1_size, size_type v_rhs2_size);

void Mp_M_assert_sizes(size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
  , size_type m_rhs_rows, size_type m_rhs_cols, BLAS_Cpp::Transp trans_rhs);

void MopM_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
  , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2);

//    end Level 1 BLAS
// @}

/* *  @name Level 2 BLAS
  */
// @{

void MtV_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols
  , BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size);

void Vp_MtV_assert_sizes(size_type v_lhs_size, size_type m_rhs1_rows
  , size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size);

//    end Level 2 BLAS
// @}

/* *  @name Level 3 BLAS
  */
// @{

void MtM_assert_sizes(
    size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
  , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2);

void Mp_MtM_assert_sizes(
    size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
  , size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
  , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2);

//    end Level 3 BLAS
// @}


// @}

#else

// inline definitions that do nothing

inline
void Vp_V_assert_sizes(size_type v_lhs_size, size_type v_rhs_size)
{}

inline
void VopV_assert_sizes(size_type v_rhs1_size, size_type v_rhs2_size)
{}

inline
void Mp_M_assert_sizes(size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
  , size_type m_rhs_rows, size_type m_rhs_cols, BLAS_Cpp::Transp trans_rhs)
{}

inline
void MopM_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
  , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2)
{}

inline
void MtV_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols
  , BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size)
{}

inline
void Vp_MtV_assert_sizes(size_type v_lhs_size, size_type m_rhs1_rows
  , size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size)
{}

inline
void MtM_assert_sizes(
    size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
  , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2)
{}

inline
void Mp_MtM_assert_sizes(
    size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
  , size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
  , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2)
{}

#endif

} // end namespace DenseLinAlgPack

#endif  // LIN_ALG_PACK_ASSERT_OP_H