TSQR::Test::DistTsqrVerifier< Ordinal, Scalar > Class Template Reference

Template version of DistTsqr accuracy test. More...

#include <Tsqr_ParTest.hpp>

List of all members.

Public Member Functions
	DistTsqrVerifier (const Teuchos::RCP< MessengerBase< Ordinal > > &ordinalComm, const Teuchos::RCP< MessengerBase< Scalar > > &scalarComm, const std::vector< int > &seed, const std::string &scalarTypeName, std::ostream &out, std::ostream &err, const bool testFactorExplicit, const bool testFactorImplicit, const bool humanReadable, const bool printMatrices, const bool debug)
	Constructor, with custom seed value.
	DistTsqrVerifier (const Teuchos::RCP< MessengerBase< Ordinal > > &ordinalComm, const Teuchos::RCP< MessengerBase< Scalar > > &scalarComm, const std::string &scalarTypeName, std::ostream &out, std::ostream &err, const bool testFactorExplicit, const bool testFactorImplicit, const bool humanReadable, const bool printMatrices, const bool debug)
	Constructor, with default seed value.
void	getSeed (std::vector< int > &seed) const
	Get seed vector for pseudorandom number generator.
void	verify (const Ordinal numCols)
	Run the DistTsqr accuracy test.

---

Detailed Description

template<class Ordinal, class Scalar>
class TSQR::Test::DistTsqrVerifier< Ordinal, Scalar >

Template version of DistTsqr accuracy test.

Definition at line 56 of file Tsqr_ParTest.hpp.

---

Constructor & Destructor Documentation

template<class Ordinal , class Scalar >

TSQR::Test::DistTsqrVerifier< Ordinal, Scalar >::DistTsqrVerifier	(	const Teuchos::RCP< MessengerBase< Ordinal > > &	ordinalComm,
		const Teuchos::RCP< MessengerBase< Scalar > > &	scalarComm,
		const std::vector< int > &	seed,
		const std::string &	scalarTypeName,
		std::ostream &	out,
		std::ostream &	err,
		const bool	testFactorExplicit,
		const bool	testFactorImplicit,
		const bool	humanReadable,
		const bool	printMatrices,
		const bool	debug
	)		[inline]

Constructor, with custom seed value.

Parameters:

scalarComm	[in/out] Communicator object over which to test.
seed	[in] 4-element vector; the random seed input of TSQR::Random::NormalGenerator (which see, since there are restrictions on the set of valid seeds)
scalarTypeName	[in] Human-readable name of the Scalar template type parameter
out	[out] Output stream to which to write results
err	[out] Output stream to which to write any debugging outputs (if applicable) or errors
testFactorExplicit	[in] Whether to test DistTsqr::factorExplicit()
testFactorImplicit	[in] Whether to test DistTsqr::factor() and DistTsqr::explicit_Q()
humanReadable	[in] Whether printed results should be easy for humans to read (vs. easy for parsers to parse)
debug	[in] Whether to write verbose debug output to err

Definition at line 93 of file Tsqr_ParTest.hpp.

template<class Ordinal , class Scalar >

TSQR::Test::DistTsqrVerifier< Ordinal, Scalar >::DistTsqrVerifier	(	const Teuchos::RCP< MessengerBase< Ordinal > > &	ordinalComm,
		const Teuchos::RCP< MessengerBase< Scalar > > &	scalarComm,
		const std::string &	scalarTypeName,
		std::ostream &	out,
		std::ostream &	err,
		const bool	testFactorExplicit,
		const bool	testFactorImplicit,
		const bool	humanReadable,
		const bool	printMatrices,
		const bool	debug
	)		[inline]

Constructor, with default seed value.

This constructor sets a default seed (for the pseudorandom number generator), which is the same seed (0,0,0,1) each time.

Parameters:

scalarComm	[in/out] Communicator object over which to test.
scalarTypeName	[in] Human-readable name of the Scalar template type parameter
out	[out] Output stream to which to write results
err	[out] Output stream to which to write any debugging outputs (if applicable) or errors
testFactorExplicit	[in] Whether to test DistTsqr::factorExplicit()
testFactorImplicit	[in] Whether to test DistTsqr::factor() and DistTsqr::explicit_Q()
humanReadable	[in] Whether printed results should be easy for humans to read (vs. easy for parsers to parse)
debug	[in] Whether to write verbose debug output to err

Definition at line 138 of file Tsqr_ParTest.hpp.

---

Member Function Documentation

template<class Ordinal , class Scalar >

void TSQR::Test::DistTsqrVerifier< Ordinal, Scalar >::getSeed

(

std::vector< int > &

seed

)

const [inline]

Get seed vector for pseudorandom number generator.

Fill seed (changing size of vector as necessary) with the seed vector used by the pseudorandom number generator. You can use this to resume the pseudorandom number stream from where you last were.

Definition at line 167 of file Tsqr_ParTest.hpp.

template<class Ordinal , class Scalar >

void TSQR::Test::DistTsqrVerifier< Ordinal, Scalar >::verify

(

const Ordinal

numCols

)

[inline]

Run the DistTsqr accuracy test.

Parameters:

numCols

[in] Number of columns in the matrix to test. Number of rows := (# MPI processors) * ncols.

Definition at line 177 of file Tsqr_ParTest.hpp.

---

The documentation for this class was generated from the following file:

• Tsqr_ParTest.hpp