/usr/include/trilinos/Thyra_TestingToolsDecl.hpp is in libtrilinos-thyra-dev 12.12.1-5.
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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | // @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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.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 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 std::string &v1_name,
const ArrayView<const Scalar1> &v1,
const std::string &v2_name,
const ArrayView<const Scalar2> &v2,
const std::string &maxRelErr_error_name,
const ScalarMag &maxRelErr_error,
const std::string &maxRelErr_warning_name,
const ScalarMag &maxRelErr_warning,
const Ptr<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 std::string &error_name,
const ArrayView<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> &errors,
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,
const Ptr<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,
const Ptr<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,
const Ptr<bool> &success,
const Ptr<std::ostream> &out
);
/** \brief Deprecated (call overload without raw pointers). */
THYRA_DEPRECATED void printTestResults(
const bool result,
const std::string &test_summary,
const bool show_all_tests,
bool *success,
std::ostream *out
);
/** \brief Control printing of test results.
*
* This class is designed to help control printing of test results and to help
* summarize test results. The idea is that by default, we might want to
* limit output when the test passes but allow it to be printed in full if the
* test fails. However, we want to ahve a testing mode show_all_tests==true
* where the test results are printed to the direct std::ostream object in
* real time to aid in debugging. To accomplish this, when
* show_all_tests==false, the output from the test is sent to disconnected
* std::ostringstream object and then is only printed if the test fails.
* Otherwise, the detailed output from the test is never printed to the direct
* std::ostream object.
*
* ToDo: Fill in detailed documentation!
*/
class TestResultsPrinter {
public:
/** \brief . */
TestResultsPrinter(const RCP<FancyOStream> &out, const bool show_all_tests);
/** \brief Print the test results on destruction if not already printed. */
~TestResultsPrinter();
/** \brief Replace the underlying output stream (used for unit testing this
* class).
*/
RCP<FancyOStream> replaceOStream(const RCP<FancyOStream> &out);
/** \brief Return the stream used for testing */
RCP<FancyOStream> getTestOStream();
/** \brief Print the test result. */
void printTestResults(const bool this_result, const Ptr<bool> &success);
private:
RCP<FancyOStream> out_;
bool show_all_tests_;
std::ostringstream ossStore_;
RCP<FancyOStream> oss_;
bool printedTestResults_;
TestResultsPrinter(); // Not defined!
TestResultsPrinter(const TestResultsPrinter&); // Not defined!
};
/** \brief Output operator to pretty print any <tt>Thyra::VectorBase</tt>
* object.
*
* Calls <tt>v.describe(o, Teuchos::VERB_EXTREME);</tt>
*
* \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>
* (and therefore MultiVectorBase) 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
#endif // THYRA_TESTING_TOOLS_DECL_HPP
|