/usr/include/trilinos/Thyra_VectorSpaceTester_decl.hpp is in libtrilinos-thyra-dev 12.4.2-2.
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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | // @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_VECTOR_SPACE_TESTER_DECL_HPP
#define THYRA_VECTOR_SPACE_TESTER_DECL_HPP
#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_VectorTester.hpp"
namespace Thyra {
/** \brief Testing class for <tt>VectorSpace</tt> and the <tt>VectorBase</tt>
* and <tt>MultiVectorBase</tt> objects that it creates.
*
* The testing function <tt>check()</tt> calls all of the methods defined in
* the interfaces <tt>VectorSpace</tt>, <tt>VectorBase</tt>,
* <tt>MultiVectorBase</tt> and <tt>VectorSpaceFactoryBase</tt> and checks
* may (but perhaps not all) of the postconditions. It would be very
* difficult to completely verify every postcondition in every situation.
*
* The behavior of the testing function <tt>check()</tt> is strongly
* influenced by a set of options.
*
* When writing new concrete implementations of <tt>VectorSpace</tt>,
* <tt>VectorBase</tt>, <tt>MultiVectorBase</tt> and
* <tt>VectorSpaceFactoryBase</tt>, a developer is likely to spend a lot of
* time debugging while in this testing function.
*
* \ingroup Thyra_Op_Vec_ANA_Development_grp
*/
template<class Scalar>
class VectorSpaceTester {
public:
/** \brief Local typedef for scalar magnitude */
typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;
/** \brief Expose a non-<tt>const</tt> reference to the <tt>VectorTester</tt>
* object used to test the <tt>MultiVectorBase</tt> interface supported by
* <tt>VectorBase</tt>.
*
* Clients can use this interface to override options directly set on
* <tt>*this</tt>.
*/
VectorTester<Scalar>& vectorTester();
/** \brief Expose a <tt>const</tt> reference to the <tt>VectorTester</tt>
* object used to test the <tt>MultiVectorBase</tt> interface supported by
* <tt>VectorBase</tt>.
*
* Clients can use this interface to query (but not change) options.
*/
const VectorTester<Scalar>& vectorTester() const;
/** \brief Set the tolerance above which a relative error will generate a
* warning message.
*
* Also calls <tt>this->vectorTester().set_all_warning_tol(warning_tol).
*/
void warning_tol( const ScalarMag &warning_tol );
/** \brief Return the warning tolerance for <tt>*this</tt>. */
ScalarMag warning_tol() const;
/** \brief Set the error above which a relative error will generate a
* an message and cause the test to fail.
*
* Also calls <tt>this->vectorTester().set_all_error_tol(error_tol).
*/
void error_tol( const ScalarMag &error_tol );
/** \brief Return the error tolerance for <tt>*this</tt>. */
ScalarMag error_tol() const;
/** \brief Set the number random vectors that is generated during each test.
*
* Also calls <tt>this->vectorTester().num_random_vectors(num_random_vectors).
*/
void num_random_vectors( const int num_random_vectors );
/** \brief Return the number of random vectors used for <tt>*this</tt> objects
* tests.
*/
int num_random_vectors() const;
/** \brief Set the number of columns to use to create test <tt>MultiVectorBase</tt> objects.
*/
STANDARD_MEMBER_COMPOSITION_MEMBERS( int, num_mv_cols );
/** \brief Set whether all of the tests will be printed independent if they
* pass or fail.
*
* Also calls <tt>this->vectorTester().show_all_tests(show_all_tests).
*/
void show_all_tests( const bool show_all_tests );
/** \brief Return the number of random vectors used for <tt>*this</tt> objects
* tests.
*/
bool show_all_tests() const;
/** \brief Set whether all of the vectors and multi-vectors will be dumped
* or not.
*
* Also calls <tt>this->vectorTester().dump_all(dump_all).
*/
void dump_all( const bool dump_all );
/** \brief Return the number of random vectors used for <tt>*this</tt> objects
* tests.
*/
bool dump_all() const;
/** \brief Default constructor which sets default parameter values.
*
* Note: It is not recommended that the client pass in values in this
* constructor since the argument list may change in the near future but
* instead use the above set functions to change an option after
* construction.
*/
VectorSpaceTester(
const ScalarMag warning_tol = 1e-13
,const ScalarMag error_tol = 1e-10
,const int num_random_vectors = 1
,const int num_mv_cols = 4
,const bool show_all_tests = false
,const bool dump_all = false
);
/** \brief Check a vector space and the objects it creates through a set of
* comprehensive tests.
*
* \param vs [in] The vector space object to test.
*
* \param out [in/out] If <tt>out != NULL</tt> then output will be sent to
* <tt>*out</tt>.
*
* The behavior of this function greatly depends on a number of options (see
* <tt>VectorSpaceTester()</tt> for the default values for these options):
*
* <ul>
*
* <li> <b><tt>print_all_tests(bool)</tt></b>: If <tt>print_all_tests() ==
* true</tt>, then some output will be sent to <tt>*out</tt> for every test
* performed. This is useful to see all of tests that are performed and in
* debugging.
*
* <li> <b><tt>dump_all(bool)</tt></b>: If <tt>dump_all() == true</tt>, then
* all of the vectors will be printed that are created during the tests.
* This option is really only needed during initial debugging and should
* only be used with small vector spaces since it will produce a lot of
* <tt>O(space.dim())</tt> output.
*
* <li> <b><tt>num_random_tests(int)</tt></b>: This is the number of random
* tests to perform per category of test. A higher number will result is
* better validation but will consume more CPU time.
*
* <li> <b><tt>warning_tol(ScalarMag)</tt></b>: Any test with a relative
* error greater than <tt>warning_tol()</tt> will result in a warning
* message printed to <tt>*out</tt> but will not result in a filed test.
*
* <li> <b><tt>error_tol(Scalar)</tt></b>: Any test with a relative error
* greater than <tt>error_tol()</tt> will result in an error message printed
* to <tt>*out</tt> and will result in a failed test.
*
* </ul>
*
* \return The function returns <tt>true</tt> if all of the tests where
* within the <tt>error_tol()</tt> and returns <tt>false</tt> if not.
*
* The best way to see what this testing function is doing is to run the
* test with <tt>out!=NULL</tt> and to look at the implementation by
* clicking on the following link to the source code:
*/
bool check(
const VectorSpaceBase<Scalar> &vs,
Teuchos::FancyOStream *out
) const;
private:
VectorTester<Scalar> vectorTester_;
ScalarMag warning_tol_;
ScalarMag error_tol_;
int num_random_vectors_;
bool show_all_tests_;
bool dump_all_;
}; // class VectorSpaceTester
// ///////////////////////////
// Inline members
template<class Scalar>
inline
VectorTester<Scalar>& VectorSpaceTester<Scalar>::vectorTester()
{
return vectorTester_;
}
template<class Scalar>
inline
const VectorTester<Scalar>& VectorSpaceTester<Scalar>::vectorTester() const
{
return vectorTester_;
}
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::warning_tol( const ScalarMag &warning_tol_in )
{
warning_tol_ = warning_tol_in;
vectorTester_.warning_tol(warning_tol_in);
}
template<class Scalar>
inline
typename VectorSpaceTester<Scalar>::ScalarMag
VectorSpaceTester<Scalar>::warning_tol() const
{
return warning_tol_;
}
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::error_tol( const ScalarMag &error_tol_in )
{
error_tol_ = error_tol_in;
vectorTester_.error_tol(error_tol_in);
}
template<class Scalar>
inline
typename VectorSpaceTester<Scalar>::ScalarMag
VectorSpaceTester<Scalar>::error_tol() const
{
return error_tol_;
}
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::num_random_vectors( const int num_random_vectors_in )
{
num_random_vectors_ = num_random_vectors_in;
vectorTester_.num_random_vectors(num_random_vectors_in);
}
template<class Scalar>
inline
int VectorSpaceTester<Scalar>::num_random_vectors() const
{
return num_random_vectors_;
}
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::show_all_tests( const bool show_all_tests_in )
{
show_all_tests_ = show_all_tests_in;
vectorTester_.show_all_tests(show_all_tests_in);
}
template<class Scalar>
inline
bool VectorSpaceTester<Scalar>::show_all_tests() const
{
return show_all_tests_;
}
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::dump_all( const bool dump_all_in )
{
dump_all_ = dump_all_in;
vectorTester_.dump_all(dump_all_in);
}
template<class Scalar>
inline
bool VectorSpaceTester<Scalar>::dump_all() const
{
return dump_all_;
}
} // namespace Thyra
#endif // THYRA_VECTOR_SPACE_TESTER_DECL_HPP
|