MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_AssertOp.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef LIN_ALG_PACK_ASSERT_OP_H
00043 #define LIN_ALG_PACK_ASSERT_OP_H
00044 
00045 #include "DenseLinAlgPack_Types.hpp"
00046 
00047 namespace DenseLinAlgPack {
00048 
00049 #ifdef LINALGPACK_CHECK_RHS_SIZES
00050 
00051 
00052 /* * @name Assertion functions for linear algebra operations.
00053   *
00054   * These functions check the sizes of the linear algebra
00055   * expressions and throw a std::length_error if
00056   * the sizes do not match.  These functions
00057   * only perform there operations if #LINALGPACK_CHECK_RHS_SIZES#
00058   * is defined.
00059   */
00060 // @{
00061 
00062 /* * @name Level 1 BLAS
00063   */
00064 // @{
00065 
00067 void Vp_V_assert_sizes(size_type v_lhs_size, size_type v_rhs_size);
00068 
00070 void VopV_assert_sizes(size_type v_rhs1_size, size_type v_rhs2_size);
00071 
00073 void Mp_M_assert_sizes(size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
00074   , size_type m_rhs_rows, size_type m_rhs_cols, BLAS_Cpp::Transp trans_rhs);
00075 
00077 void MopM_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
00078   , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2);
00079 
00080 //    end Level 1 BLAS
00081 // @}
00082 
00083 /* *  @name Level 2 BLAS
00084   */
00085 // @{
00086 
00088 void MtV_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols
00089   , BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size);
00090 
00092 void Vp_MtV_assert_sizes(size_type v_lhs_size, size_type m_rhs1_rows
00093   , size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size);
00094 
00095 //    end Level 2 BLAS
00096 // @}
00097 
00098 /* *  @name Level 3 BLAS
00099   */
00100 // @{
00101 
00103 void MtM_assert_sizes(
00104     size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
00105   , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2);
00106 
00108 void Mp_MtM_assert_sizes(
00109     size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
00110   , size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
00111   , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2);
00112 
00113 //    end Level 3 BLAS
00114 // @}
00115 
00116 
00117 // @}
00118 
00119 #else
00120 
00121 // inline definitions that do nothing
00122 
00123 inline
00124 void Vp_V_assert_sizes(size_type v_lhs_size, size_type v_rhs_size)
00125 {}
00126 
00127 inline
00128 void VopV_assert_sizes(size_type v_rhs1_size, size_type v_rhs2_size)
00129 {}
00130 
00131 inline
00132 void Mp_M_assert_sizes(size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
00133   , size_type m_rhs_rows, size_type m_rhs_cols, BLAS_Cpp::Transp trans_rhs)
00134 {}
00135 
00136 inline
00137 void MopM_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
00138   , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2)
00139 {}
00140 
00141 inline
00142 void MtV_assert_sizes(size_type m_rhs1_rows, size_type m_rhs1_cols
00143   , BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size)
00144 {}
00145 
00146 inline
00147 void Vp_MtV_assert_sizes(size_type v_lhs_size, size_type m_rhs1_rows
00148   , size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1, size_type v_rhs2_size)
00149 {}
00150 
00151 inline
00152 void MtM_assert_sizes(
00153     size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
00154   , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2)
00155 {}
00156 
00157 inline
00158 void Mp_MtM_assert_sizes(
00159     size_type m_lhs_rows, size_type m_lhs_cols, BLAS_Cpp::Transp trans_lhs
00160   , size_type m_rhs1_rows, size_type m_rhs1_cols, BLAS_Cpp::Transp trans_rhs1
00161   , size_type m_rhs2_rows, size_type m_rhs2_cols, BLAS_Cpp::Transp trans_rhs2)
00162 {}
00163 
00164 #endif
00165 
00166 } // end namespace DenseLinAlgPack
00167 
00168 #endif  // LIN_ALG_PACK_ASSERT_OP_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines