Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Public Types | Public Member Functions | Static Public Member Functions
TSQR::Test::FullTsqrVerifierCaller Class Reference

Invokes FullTsqrVerifier::run() over all Scalar types in a type list. More...

#include <Tsqr_FullTsqrTest.hpp>

List of all members.

Public Types

typedef Kokkos::SerialNode node_type
 The Kokkos Node type to use.
typedef int ordinal_type
 The (local) Ordinal type to use for TSQR.

Public Member Functions

Teuchos::RCP< const
Teuchos::ParameterList
getValidParameterList () const
 Return a valid parameter list for verifying Tsqr.
template<class TypeListType >
void run (const Teuchos::RCP< Teuchos::ParameterList > &testParams)
 Run TsqrVerifier<T>::run() for every type in the type list.
 FullTsqrVerifierCaller (const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< const node_type > &node, const std::vector< int > &randomSeed)
 Full constructor.
 FullTsqrVerifierCaller (const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 One-argument constructor.
 FullTsqrVerifierCaller (const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< const node_type > &node)
 Two-argument constructor.

Static Public Member Functions

static std::vector< int > validateRandomSeed (const std::vector< int > &seed)
 Validate the given random seed.
static std::vector< int > defaultRandomSeed ()
 Default random seed.

Detailed Description

Invokes FullTsqrVerifier::run() over all Scalar types in a type list.

Author:
Mark Hoemmen

Use this class to test the full TSQR implementation in Tsqr. It will test Tsqr over a list of Scalar types that you define, using Cons and NullCons.

Definition at line 579 of file Tsqr_FullTsqrTest.hpp.


Member Typedef Documentation

The Kokkos Node type to use.

Definition at line 583 of file Tsqr_FullTsqrTest.hpp.

The (local) Ordinal type to use for TSQR.

This must be a type for which Teuchos::BLAS<ordinal_type, Scalar> and Teuchos::LAPACK<ordinal_type, Scalar> each have an instantiation. That means a signed integer type. LAPACK and the BLAS can be built with signed 64-bit integers (int64_t), but usually they are only built with signed 32-bit integers (int).

Definition at line 594 of file Tsqr_FullTsqrTest.hpp.


Constructor & Destructor Documentation

TSQR::Test::FullTsqrVerifierCaller::FullTsqrVerifierCaller ( const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< const node_type > &  node,
const std::vector< int > &  randomSeed 
) [inline]

Full constructor.

Parameters:
comm[in] Communicator (with one or more processes) over which to perform tests.
node[in] Kokkos Node instance.
randomSeed[in] The seed for LAPACK's pseudorandom number generator. An array of four integers, satisfying the requirements of LAPACK's _LARNV routines. The array elements must be in [0,4095], and the last element (iseed[3]) must be odd. Call defaultRandomSeed() for a constant default value (if you want the same results each time; not "random" but reproducible).

Definition at line 695 of file Tsqr_FullTsqrTest.hpp.

TSQR::Test::FullTsqrVerifierCaller::FullTsqrVerifierCaller ( const Teuchos::RCP< const Teuchos::Comm< int > > &  comm) [inline]

One-argument constructor.

Fills in defaults for the other arguments that the full constructor would take.

Parameters:
comm[in] Communicator (with one or more processes) over which to perform tests.

Definition at line 708 of file Tsqr_FullTsqrTest.hpp.

TSQR::Test::FullTsqrVerifierCaller::FullTsqrVerifierCaller ( const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< const node_type > &  node 
) [inline]

Two-argument constructor.

Fills in defaults for the other arguments that the full constructor would take.

Parameters:
comm[in] Communicator (with one or more processes) over which to perform tests.
node[in] Kokkos Node instance.

Definition at line 723 of file Tsqr_FullTsqrTest.hpp.


Member Function Documentation

Teuchos::RCP<const Teuchos::ParameterList> TSQR::Test::FullTsqrVerifierCaller::getValidParameterList ( ) const [inline]

Return a valid parameter list for verifying Tsqr.

Call this once to get a valid parameter list with all the defaults filled in. This list is valid for all the Scalar types which TsqrVerifierCaller::run tests.

Definition at line 602 of file Tsqr_FullTsqrTest.hpp.

template<class TypeListType >
void TSQR::Test::FullTsqrVerifierCaller::run ( const Teuchos::RCP< Teuchos::ParameterList > &  testParams) [inline]

Run TsqrVerifier<T>::run() for every type in the type list.

TypeListType should be either a NullCons (representing an empty type list, in which case this function does nothing), or a Cons (whose CarType is a Scalar type to test, and whose CdrType is either a NullCons or a Cons).

Parameters:
testParams[in/out] List of parameters for all tests to run. Call getValidParameterList() to get a valid list of parameters with default values and documentation.

Definition at line 671 of file Tsqr_FullTsqrTest.hpp.

static std::vector<int> TSQR::Test::FullTsqrVerifierCaller::validateRandomSeed ( const std::vector< int > &  seed) [inline, static]

Validate the given random seed.

Definition at line 732 of file Tsqr_FullTsqrTest.hpp.

static std::vector<int> TSQR::Test::FullTsqrVerifierCaller::defaultRandomSeed ( ) [inline, static]

Default random seed.

Definition at line 749 of file Tsqr_FullTsqrTest.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends