DenseLinAlgPack: Concreate C++ Classes for Dense Blas-Compatible Linear Algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DenseLinAlgPack_MatVecCompare.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef MAT_VEC_COMPARE_H
43 #define MAT_VEC_COMPARE_H
44 
45 #include <limits>
46 #if defined(_GNU_GXX)
47 #include <cmath>
48 #else
49 #include <math.h>
50 #endif
51 
52 #include "DenseLinAlgPack_Types.hpp"
53 #include "TestingHelperPack_update_success.hpp"
54 
55 namespace DenseLinAlgPack {
56 
57 using TestingHelperPack::update_success;
58 
59 /* * @name DVectorSlice and DMatrixSlice comparison functions.
60  *
61  * These functions compare the elements of two DVectorSlice or DMatrixSlice
62  * objects. If any of the corresponding elements does not obey
63  * abs(ele1 - ele2) < sqrt(eps) then the functions return false, otherwise
64  * they return true. An exact test (bits) is not performed to allow for some round-off
65  * error to occur and still equate.
66  */
67 // @{
68 
70 const value_type sqrt_eps
71 #if defined(_GNU_GXX)
72  = std::sqrt(std::numeric_limits<value_type>::epsilon());
73 #elif defined(_CPQ_CXX)
74  = ::sqrt(std::numeric_limits<value_type>::epsilon());
75 #else
76  = ::sqrt(std::numeric_limits<value_type>::epsilon());
77 #endif
78 
80 bool comp(const DVectorSlice& vs1, const DVectorSlice& vs2);
81 
83 bool comp(const DVectorSlice& vs, value_type alpha);
84 
86 bool comp(const DMatrixSlice& gms1, BLAS_Cpp::Transp trans1
87  , const DMatrixSlice& gms2, BLAS_Cpp::Transp trans2);
88 
90 //bool comp(const DMatrixSlice& gms1, const DMatrixSlice& gms2);
91 
92 inline
94 bool comp(const DMatrixSlice& gms1, const DMatrixSlice& gms2)
95 {
96  return comp(gms1, BLAS_Cpp::no_trans, gms2, BLAS_Cpp::no_trans);
97 }
98 
100 bool comp(const DMatrixSlice& gms1, value_type alpha);
101 
103 bool comp(const DMatrixSliceTriEle& tri_gms1, const DMatrixSliceTriEle& tri_gms2);
104 
106 bool comp(const DMatrixSliceTriEle& tri_gms1, value_type alpha);
107 
109 bool comp_less(const DVectorSlice& vs, value_type alpha);
110 
111 // @}
112 
113 } // end namespace DenseLinAlgPack
114 
115 // ////////////////////////////////////
116 // Inline definitions
117 
118 //inline
119 //bool DenseLinAlgPack::comp(const DMatrixSlice& gms1, const DMatrixSlice& gms2)
120 //{
121 // return comp(gms1, BLAS_Cpp::no_trans, gms2, BLAS_Cpp::no_trans);
122 //}
123 
124 
125 #endif // MAT_VEC_COMPARE_H
Transp