/usr/include/trilinos/Thyra_TestingToolsDecl.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | // @HEADER
// ***********************************************************************
//
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_TESTING_TOOLS_DECL_HPP
#define THYRA_TESTING_TOOLS_DECL_HPP
#include "Thyra_OperatorVectorTypes.hpp"
#include "Teuchos_VerbosityLevel.hpp"
#include "Teuchos_TestingHelpers.hpp"
namespace Thyra {
/** \brief .
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
inline const std::string passfail(const bool result)
{
return Teuchos::passfail(result);
}
/** \brief .
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template <class Scalar>
inline
typename Teuchos::ScalarTraits<Scalar>::magnitudeType
relErr( const Scalar &s1, const Scalar &s2 )
{
return Teuchos::relErr<Scalar>(s1, s2);
}
/** \brief Return relative error of two vectors.
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template <class Scalar>
typename Teuchos::ScalarTraits<Scalar>::magnitudeType
relVectorErr( const VectorBase<Scalar> &v1, const VectorBase<Scalar> &v2 );
/** \brief Compute, check and optionally print the relative error in two scalars.
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
inline
bool testRelErr(
const std::string &v1_name
,const Scalar &v1
,const std::string &v2_name
,const Scalar &v2
,const std::string &maxRelErr_error_name
,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &maxRelErr_error
,const std::string &maxRelErr_warning_name
,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &maxRelErr_warning
,std::ostream *out
,const std::string &leadingIndent = std::string("")
)
{
// ToDo: Indent correctly!
return Teuchos::testRelErr(v1_name, v1, v2_name, v2,
maxRelErr_error_name, maxRelErr_error,
maxRelErr_warning_name, maxRelErr_warning,
Teuchos::ptr(out) );
}
/** \brief Compute, check and optionally print the relative errors in two
* scalar arays.
*
* \param v1 [in] Array (length <tt>num_scalars</tt>).
* \param v2 [in] Array (length <tt>num_scalars</tt>).
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar1, class Scalar2, class ScalarMag>
bool testRelErrors(
const int num_scalars
,const std::string &v1_name
,const Scalar1 v1[]
,const std::string &v2_name
,const Scalar2 v2[]
,const std::string &maxRelErr_error_name
,const ScalarMag &maxRelErr_error
,const std::string &maxRelErr_warning_name
,const ScalarMag &maxRelErr_warning
,std::ostream *out
,const std::string &leadingIndent = std::string("")
);
/** \brief Compute, check and optionally print the relative errors in two vectors.
*
* This function only looks at the difference in the relative errors in the
* natural norm of the difference between two vectors. This does not perform
* a component-by-component check.
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
bool testRelNormDiffErr(
const std::string &v1_name,
const VectorBase<Scalar> &v1,
const std::string &v2_name,
const VectorBase<Scalar> &v2,
const std::string &maxRelErr_error_name,
const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &maxRelErr_error,
const std::string &maxRelErr_warning_name,
const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &maxRelErr_warning,
std::ostream *out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::VERB_LOW,
const std::string &leadingIndent = std::string("")
);
/** \brief Check that an error is less than some error tolerence.
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
bool testMaxErr(
const std::string &error_name
,const Scalar &error
,const std::string &max_error_name
,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &max_error
,const std::string &max_warning_name
,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &max_warning
,std::ostream *out
,const std::string &leadingIndent = std::string("")
);
/** \brief Check that an array of errors is less than some error tolerence.
*
* \param error [in] Array (length <tt>num_scalars</tt>).
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
bool testMaxErrors(
const int num_scalars
,const std::string &error_name
,const Scalar error[]
,const std::string &max_error_name
,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &max_error
,const std::string &max_warning_name
,const typename Teuchos::ScalarTraits<Scalar>::magnitudeType &max_warning
,std::ostream *out
,const std::string &leadingIndent = std::string("")
);
/** \brief Check a boolean result against expected result.
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
bool testBoolExpr(
const std::string &boolExprName
,const bool &boolExpr
,const bool &boolExpected
,std::ostream *out
,const std::string &leadingIndent = std::string("")
);
/** \brief Print summary outputting for a test or just <tt>passed</tt> or
* <tt>failed</tt>.
*
* @param result [in] Bool for of the test was successful or unsuccessful.
* @param test_summary [in] The summary of the test that was just completed.
* @param show_all_tests [in] Bool for if the test summary should be shown even if
* the test passed.
* @param success [out] Update of the success bool.
* @param out [out] Stream where output will be sent if <tt>*out!=NULL</tt>.
*
* Preconditions:<ul>
* <li><tt>success!=NULL</tt>
* </ul>
*
* Preconditions:<ul>
* <li><tt>*success==false</tt> if <tt>result==false</tt>
* </ul>
*
* Just look at the definition of this function to see what it does.
*/
void printTestResults(
const bool result
,const std::string &test_summary
,const bool show_all_tests
,bool *success
,std::ostream *out
);
/** \brief Output operator to pretty print any <tt>Thyra::VectorBase</tt> object.
*
* ToDo: Finish documentation!
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
std::ostream& operator<<( std::ostream& o, const VectorBase<Scalar>& v );
/** \brief Output operator to pretty print any <tt>Thyra::LinearOpBase</tt> object.
*
* Calls <tt>M.describe(o,Teuchos::VERB_EXTREME);</tt>
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
std::ostream& operator<<( std::ostream& o, const LinearOpBase<Scalar>& M );
} // namespace Thyra
// //////////////////////////
// Inline functions
inline
void Thyra::printTestResults(
const bool result
,const std::string &test_summary
,const bool show_all_tests
,bool *success
,std::ostream *out
)
{
if(!result) *success = false;
if(out) {
if( !result || show_all_tests )
*out << std::endl << test_summary;
else
*out << "passed!\n";
}
}
#endif // THYRA_TESTING_TOOLS_DECL_HPP
|