Thyra_MultiVectorStdOpsTester_decl.hpp

// @HEADER
// *****************************************************************************
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//
// Copyright 2004 NTESS and the Thyra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef THYRA_MULTI_VECTOR_STD_OPS_TESTER_DECL_HPP
#define THYRA_MULTI_VECTOR_STD_OPS_TESTER_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_TestingTools.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace Thyra {

template <class Scalar>
class MultiVectorStdOpsTester {
public:

  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, warning_tol );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, error_tol );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( int, num_mv_cols );

  MultiVectorStdOpsTester(
    const ScalarMag    &warning_tol = 0
    ,const ScalarMag   &error_tol   = 0
    ,const int         num_mv_cols  = 4
    );

  bool checkStdOps(
    const VectorSpaceBase<Scalar>    &vecSpc
    ,std::ostream                    *out      = 0
    ,const bool                      &dumpAll  = false
    );

};

} // namespace Thyra

#endif // THYRA_MULTI_VECTOR_STD_OPS_TESTER_DECL_HPP