MOOCHO (Single Doxygen Collection) Version of the Day
DenseLinAlgPack_MatVecCompare.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 MAT_VEC_COMPARE_H
00043 #define MAT_VEC_COMPARE_H
00044 
00045 #include <limits>
00046 #if defined(_GNU_GXX)
00047 #include <cmath>
00048 #else
00049 #include <math.h>
00050 #endif
00051 
00052 #include "DenseLinAlgPack_Types.hpp"
00053 #include "TestingHelperPack_update_success.hpp"
00054 
00055 namespace DenseLinAlgPack {
00056 
00057 using TestingHelperPack::update_success;
00058 
00059 /* * @name DVectorSlice and DMatrixSlice comparison functions.
00060   *
00061   * These functions compare the elements of two DVectorSlice or DMatrixSlice
00062   * objects.  If any of the corresponding elements does not obey
00063   * abs(ele1 - ele2) < sqrt(eps) then the functions return false, otherwise
00064   * they return true.  An exact test (bits) is not performed to allow for some round-off
00065   * error to occur and still equate.
00066   */
00067 // @{
00068 
00070 const value_type sqrt_eps
00071 #if defined(_GNU_GXX)
00072   = std::sqrt(std::numeric_limits<value_type>::epsilon());
00073 #elif defined(_CPQ_CXX)
00074   = ::sqrt(std::numeric_limits<value_type>::epsilon());
00075 #else
00076   = ::sqrt(std::numeric_limits<value_type>::epsilon());
00077 #endif
00078 
00080 bool comp(const DVectorSlice& vs1, const DVectorSlice& vs2);
00081 
00083 bool comp(const DVectorSlice& vs, value_type alpha);
00084 
00086 bool comp(const DMatrixSlice& gms1, BLAS_Cpp::Transp trans1
00087   , const DMatrixSlice& gms2, BLAS_Cpp::Transp trans2);
00088 
00090 //bool comp(const DMatrixSlice& gms1, const DMatrixSlice& gms2);
00091 
00092 inline
00094 bool comp(const DMatrixSlice& gms1, const DMatrixSlice& gms2)
00095 {
00096   return comp(gms1, BLAS_Cpp::no_trans, gms2, BLAS_Cpp::no_trans);
00097 }
00098 
00100 bool comp(const DMatrixSlice& gms1, value_type alpha);
00101 
00103 bool comp(const DMatrixSliceTriEle& tri_gms1, const DMatrixSliceTriEle& tri_gms2);
00104 
00106 bool comp(const DMatrixSliceTriEle& tri_gms1, value_type alpha);
00107 
00109 bool comp_less(const DVectorSlice& vs, value_type alpha);
00110 
00111 // @}
00112 
00113 } // end namespace DenseLinAlgPack
00114 
00115 // ////////////////////////////////////
00116 // Inline definitions
00117 
00118 //inline
00119 //bool DenseLinAlgPack::comp(const DMatrixSlice& gms1, const DMatrixSlice& gms2)
00120 //{
00121 //  return comp(gms1, BLAS_Cpp::no_trans, gms2, BLAS_Cpp::no_trans);
00122 //}
00123 
00124 
00125 #endif  // MAT_VEC_COMPARE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines