Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_LocalTestingHelpers.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) 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 Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_LOCAL_TESTING_HELPERS_HPP
43 #define TEUCHOS_LOCAL_TESTING_HELPERS_HPP
44 
45 
57 
58 
63 #define ECHO( statement ) \
64  TEUCHOS_ECHO( statement, out )
65 
66 
71 #define TEST_ASSERT( v1 ) \
72  TEUCHOS_TEST_ASSERT( v1, out, success )
73 
74 
79 #define TEST_EQUALITY_CONST( v1, v2 ) \
80  TEUCHOS_TEST_EQUALITY_CONST( v1, v2, out, success )
81 
82 
87 #define TEST_EQUALITY( v1, v2 ) \
88  TEUCHOS_TEST_EQUALITY( v1, v2, out, success )
89 
90 
95 #define TEST_INEQUALITY_CONST( v1, v2 ) \
96  TEUCHOS_TEST_INEQUALITY_CONST( v1, v2, out, success )
97 
98 
103 #define TEST_INEQUALITY( v1, v2 ) \
104  TEUCHOS_TEST_INEQUALITY( v1, v2, out, success )
105 
106 
112 #define TEST_FLOATING_EQUALITY( v1, v2, tol ) \
113  TEUCHOS_TEST_FLOATING_EQUALITY( v1, v2, tol, out, success )
114 
115 
120 #define TEST_ITER_EQUALITY( iter1, iter2 ) \
121  TEUCHOS_TEST_ITER_EQUALITY( iter1, iter2, out, success )
122 
123 
128 #define TEST_ITER_INEQUALITY( iter1, iter2 ) \
129  TEUCHOS_TEST_ITER_INEQUALITY( iter1, iter2, out, success )
130 
131 
136 #define TEST_ARRAY_ELE_EQUALITY( a, i, val ) \
137  TEUCHOS_TEST_ARRAY_ELE_EQUALITY( a, i, val, false, out, local_success )
138 
139 
144 #define TEST_ARRAY_ELE_INEQUALITY( a, i, val ) \
145  TEUCHOS_TEST_ARRAY_ELE_INEQUALITY( a, i, val, false, out, local_success )
146 
147 
152 #define TEST_COMPARE( v1, comp, v2 ) \
153  TEUCHOS_TEST_COMPARE( v1, comp, v2, out, success )
154 
155 
161 #define TEST_COMPARE_CONST( v1, comp, v2 ) \
162  TEUCHOS_TEST_COMPARE_CONST( v1, comp, v2, out, success )
163 
164 
172 #define TEST_COMPARE_ARRAYS( a1, a2 ) \
173  { \
174  const bool l_result = compareArrays(a1,#a1,a2,#a2,out); \
175  if (!l_result) success = false; \
176  }
177 
178 
186 #define TEST_COMPARE_FLOATING_ARRAYS( a1, a2, tol ) \
187  { \
188  const bool result = compareFloatingArrays(a1,#a1,a2,#a2,tol,out); \
189  if (!result) success = false; \
190  }
191 
192 
198 #define TEST_THROW( code, ExceptType ) \
199  TEUCHOS_TEST_THROW( code, ExceptType, out, success )
200 
201 
206 #define TEST_NOTHROW( code ) \
207  TEUCHOS_TEST_NOTHROW( code, out, success )
208 
209 
210 #endif // TEUCHOS_LOCAL_TESTING_HELPERS_HPP
Utilities to make writing tests easier.