Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos_Assert.hpp
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_ASSERT_HPP
43#define TEUCHOS_ASSERT_HPP
44
45
47
48
55#define TEUCHOS_ASSERT(assertion_test) TEUCHOS_TEST_FOR_EXCEPT(!(assertion_test))
56
57#ifdef TEUCHOS_DEBUG
62#define TEUCHOS_DEBUG_ASSERT(assertion_test) TEUCHOS_ASSERT(assertion_test)
63#else
64#define TEUCHOS_DEBUG_ASSERT(assertion_test)
65#endif
66
67
82#define TEUCHOS_ASSERT_IN_RANGE_UPPER_EXCLUSIVE( index, lower_inclusive, upper_exclusive ) \
83 { \
84 TEUCHOS_TEST_FOR_EXCEPTION( \
85 !( (lower_inclusive) <= (index) && (index) < (upper_exclusive) ), \
86 std::out_of_range, \
87 "Error, the index " #index " = " << (index) << " does not fall in the range" \
88 "["<<(lower_inclusive)<<","<<(upper_exclusive)<<")!" ); \
89 }
90
91
105#define TEUCHOS_ASSERT_EQUALITY( val1, val2 ) \
106 { \
107 TEUCHOS_TEST_FOR_EXCEPTION( \
108 (val1) != (val2), std::out_of_range, \
109 "Error, (" #val1 " = " << (val1) << ") != (" #val2 " = " << (val2) << ")!" ); \
110 }
111
112
126#define TEUCHOS_ASSERT_INEQUALITY( val1, comp, val2 ) \
127 { \
128 TEUCHOS_TEST_FOR_EXCEPTION( \
129 !( (val1) comp (val2) ), std::out_of_range, \
130 "Error, (" #val1 " = " << (val1) << ") " \
131 #comp " (" #val2 " = " << (val2) << ")! FAILED!" ); \
132 }
133
134
135#endif // TEUCHOS_ASSERT_HPP
Standard test and throw macros.