#include <directoryTest_Impl.hpp>

Inheritance diagram for Zoltan2::IDs< gid_t, lid_t, user_t >:

Public Member Functions
	IDs ()

	IDs (size_t totalIds_, size_t idBase_, size_t idStride_, Teuchos::RCP< const Teuchos::Comm< int > > &comm_, int mode_, const std::string &test_name_, bool print_detailed_output_, bool performance_test_, bool bUseLocalIDs_)
	Construct IDs. More...

virtual void	debug_print_subsets_and_decisions ()

void	printResultMessage (bool pass) const

const std::string &	get_test_name () const

virtual bool	evaluateTests () const =0
	evaluateTests - determine if test worked More...

int	getMode () const
	getMode - Replace, Add, or Aggregate More...

bool	did_test_pass () const
	did_test_pass - did test pass More...

virtual std::string	get_test_style () const =0
	get_test_style the test is either vector user_t or single user_t the test is either multiple gids or single gid so 4 combinations are possible - this just describes it More...

void	print () const
	detailed notes on update IDs, find IDs, etc More...

Protected Member Functions
std::string	get_mode_name () const

bool	trueForAtLeastOneProc (int index, int rank) const

bool	subset1 (int index, int rank) const

bool	subset2 (int index, int rank) const

virtual int	convert_gid_to_index (const gid_t &gid) const =0

virtual gid_t	convert_index_to_gid (int index) const =0

int	proc_update_gid (gid_t gid, int rank) const

int	proc_find_gid (gid_t gid, int rank) const

int	proc_remove_gid (gid_t gid, int rank) const

virtual user_t	get_not_found_user () const =0

virtual lid_t	get_not_found_lid () const =0

virtual void	initialize_with_not_found_user ()

virtual void	initialize_with_not_found_lid ()

bool	removedIDGlobally (gid_t gid) const

int	sharedCount (gid_t gid) const

void	print_gids (const std::vector< gid_t > &printIds, std::string name) const

void	print_lids (const std::vector< lid_t > &printIds, std::string name) const

virtual void	print_user_data () const =0

virtual void	print_lid_data () const

virtual size_t	gid_seed_value (const gid_t &gid) const =0

virtual std::string	gid_to_string (gid_t gid) const =0

virtual std::string	lid_to_string (lid_t lid) const =0

virtual bool	check_lid_equal (const lid_t &a, const lid_t &b) const =0

virtual user_t	get_expected_user (gid_t gid) const =0

virtual user_t	get_initial_user (gid_t gid, int rank) const =0

virtual lid_t	get_initial_lid (gid_t gid) const =0

virtual void	execute ()

virtual void	setup ()

virtual void	test ()=0

template<typename directory_t >
void	test_implement ()

void	analyze ()

void	output ()

Protected Attributes
size_t	totalIds

size_t	idBase

size_t	idStride

Teuchos::RCP< const Teuchos::Comm< int > >	comm

size_t	maxPrintSize

int	mode

std::vector< gid_t >	update_gids

std::vector< lid_t >	update_lids

std::vector< user_t >	update_user

std::vector< gid_t >	find_gids

std::vector< lid_t >	find_lids

std::vector< user_t >	find_user

std::vector< gid_t >	remove_gids

bool	did_setup

std::string	test_name

bool	passed

bool	print_detailed_output

bool	performance_test

bool	bUseLocalIDs

Detailed Description

template<typename gid_t, typename lid_t, typename user_t>
class Zoltan2::IDs< gid_t, lid_t, user_t >

Definition at line 128 of file directoryTest_Impl.hpp.

Constructor & Destructor Documentation

template<typename gid_t , typename lid_t , typename user_t >

Zoltan2::IDs< gid_t, lid_t, user_t >::IDs ( )

inline

Definition at line 134 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

Zoltan2::IDs< gid_t, lid_t, user_t >::IDs	(	size_t	totalIds_,
		size_t	idBase_,
		size_t	idStride_,
		Teuchos::RCP< const Teuchos::Comm< int > > &	comm_,
		int	mode_,
		const std::string &	test_name_,
		bool	print_detailed_output_,
		bool	performance_test_,
		bool	bUseLocalIDs_
	)

inline

Construct IDs.

Parameters

[in]	totalIds_	is total gid count across all procs
[in]	idBase_	is initial gid value
[in]	idStride_	is gid spacing
[in]	comm_	is the process communicator
[in]	mode_	is above enum (Replace, Add, or Aggregate)
[in]	test_name_	is helper string used for logging info

Note that in the current setup the derived class is responsible for calling execute() for proper initialization.

Definition at line 147 of file directoryTest_Impl.hpp.

Member Function Documentation

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::debug_print_subsets_and_decisions ( )

inlinevirtual

Definition at line 160 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::printResultMessage ( bool pass ) const

inline

Definition at line 217 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

const std::string& Zoltan2::IDs< gid_t, lid_t, user_t >::get_test_name ( ) const

inline

Definition at line 227 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual bool Zoltan2::IDs< gid_t, lid_t, user_t >::evaluateTests ( ) const

pure virtual

evaluateTests - determine if test worked

Implemented in Zoltan2::Vector_User< gid_t, lid_t, user_t >, and Zoltan2::Single_User< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::IDs< gid_t, lid_t, user_t >::getMode ( ) const

inline

getMode - Replace, Add, or Aggregate

Definition at line 235 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::did_test_pass ( ) const

inline

did_test_pass - did test pass

Definition at line 239 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual std::string Zoltan2::IDs< gid_t, lid_t, user_t >::get_test_style ( ) const

pure virtual

get_test_style the test is either vector user_t or single user_t the test is either multiple gids or single gid so 4 combinations are possible - this just describes it

Implemented in Zoltan2::Vector_User_Multiple_GID< gid_t, lid_t, user_t >, Zoltan2::Vector_User_Single_GID< gid_t, lid_t, user_t >, Zoltan2::Single_User_Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_User_Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::print ( ) const

inline

detailed notes on update IDs, find IDs, etc

Definition at line 250 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::string Zoltan2::IDs< gid_t, lid_t, user_t >::get_mode_name ( ) const

inlineprotected

Definition at line 284 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::trueForAtLeastOneProc	(	int	index,
		int	rank
	)		const

inlineprotected

Definition at line 294 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::subset1	(	int	index,
		int	rank
	)		const

inlineprotected

Definition at line 299 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::subset2	(	int	index,
		int	rank
	)		const

inlineprotected

Definition at line 304 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual int Zoltan2::IDs< gid_t, lid_t, user_t >::convert_gid_to_index ( const gid_t & gid ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual gid_t Zoltan2::IDs< gid_t, lid_t, user_t >::convert_index_to_gid ( int index ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::IDs< gid_t, lid_t, user_t >::proc_update_gid	(	gid_t	gid,
		int	rank
	)		const

inlineprotected

Definition at line 319 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::IDs< gid_t, lid_t, user_t >::proc_find_gid	(	gid_t	gid,
		int	rank
	)		const

inlineprotected

Definition at line 338 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::IDs< gid_t, lid_t, user_t >::proc_remove_gid	(	gid_t	gid,
		int	rank
	)		const

inlineprotected

Definition at line 354 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual user_t Zoltan2::IDs< gid_t, lid_t, user_t >::get_not_found_user ( ) const

protectedpure virtual

Implemented in Zoltan2::Vector_User< gid_t, lid_t, user_t >, and Zoltan2::Single_User< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual lid_t Zoltan2::IDs< gid_t, lid_t, user_t >::get_not_found_lid ( ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::initialize_with_not_found_user ( )

inlineprotectedvirtual

Definition at line 379 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::initialize_with_not_found_lid ( )

inlineprotectedvirtual

Definition at line 385 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::removedIDGlobally ( gid_t gid ) const

inlineprotected

Definition at line 390 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::IDs< gid_t, lid_t, user_t >::sharedCount ( gid_t gid ) const

inlineprotected

Definition at line 402 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::print_gids	(	const std::vector< gid_t > &	printIds,
		std::string	name
	)		const

inlineprotected

Definition at line 417 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::print_lids	(	const std::vector< lid_t > &	printIds,
		std::string	name
	)		const

inlineprotected

Definition at line 430 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::print_user_data ( ) const

protectedpure virtual

Implemented in Zoltan2::Vector_User< gid_t, lid_t, user_t >, and Zoltan2::Single_User< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::print_lid_data ( ) const

inlineprotectedvirtual

Definition at line 445 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual size_t Zoltan2::IDs< gid_t, lid_t, user_t >::gid_seed_value ( const gid_t & gid ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual std::string Zoltan2::IDs< gid_t, lid_t, user_t >::gid_to_string ( gid_t gid ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual std::string Zoltan2::IDs< gid_t, lid_t, user_t >::lid_to_string ( lid_t lid ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual bool Zoltan2::IDs< gid_t, lid_t, user_t >::check_lid_equal	(	const lid_t &	a,
		const lid_t &	b
	)		const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual user_t Zoltan2::IDs< gid_t, lid_t, user_t >::get_expected_user ( gid_t gid ) const

protectedpure virtual

Implemented in Zoltan2::Vector_User< gid_t, lid_t, user_t >, and Zoltan2::Single_User< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual user_t Zoltan2::IDs< gid_t, lid_t, user_t >::get_initial_user	(	gid_t	gid,
		int	rank
	)		const

protectedpure virtual

Implemented in Zoltan2::Vector_User< gid_t, lid_t, user_t >, and Zoltan2::Single_User< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual lid_t Zoltan2::IDs< gid_t, lid_t, user_t >::get_initial_lid ( gid_t gid ) const

protectedpure virtual

Implemented in Zoltan2::Multiple_GID< gid_t, lid_t, user_t >, and Zoltan2::Single_GID< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::execute ( )

inlineprotectedvirtual

Definition at line 496 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::setup ( )

inlineprotectedvirtual

Definition at line 505 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::IDs< gid_t, lid_t, user_t >::test ( )

protectedpure virtual

Implemented in Zoltan2::Vector_User< gid_t, lid_t, user_t >, and Zoltan2::Single_User< gid_t, lid_t, user_t >.

template<typename gid_t , typename lid_t , typename user_t >

template<typename directory_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::test_implement ( )

inlineprotected

Definition at line 576 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::analyze ( )

inlineprotected

Definition at line 641 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::IDs< gid_t, lid_t, user_t >::output ( )

inlineprotected

Definition at line 649 of file directoryTest_Impl.hpp.

Member Data Documentation

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::IDs< gid_t, lid_t, user_t >::totalIds

protected

Definition at line 659 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::IDs< gid_t, lid_t, user_t >::idBase

protected

Definition at line 660 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::IDs< gid_t, lid_t, user_t >::idStride

protected

Definition at line 661 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

Teuchos::RCP<const Teuchos::Comm<int> > Zoltan2::IDs< gid_t, lid_t, user_t >::comm

protected

Definition at line 663 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::IDs< gid_t, lid_t, user_t >::maxPrintSize

protected

Definition at line 664 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::IDs< gid_t, lid_t, user_t >::mode

protected

Definition at line 665 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<gid_t> Zoltan2::IDs< gid_t, lid_t, user_t >::update_gids

protected

Definition at line 666 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<lid_t> Zoltan2::IDs< gid_t, lid_t, user_t >::update_lids

protected

Definition at line 667 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<user_t> Zoltan2::IDs< gid_t, lid_t, user_t >::update_user

protected

Definition at line 668 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<gid_t> Zoltan2::IDs< gid_t, lid_t, user_t >::find_gids

protected

Definition at line 669 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<lid_t> Zoltan2::IDs< gid_t, lid_t, user_t >::find_lids

protected

Definition at line 670 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<user_t> Zoltan2::IDs< gid_t, lid_t, user_t >::find_user

protected

Definition at line 671 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::vector<gid_t> Zoltan2::IDs< gid_t, lid_t, user_t >::remove_gids

protected

Definition at line 672 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::did_setup

protected

Definition at line 673 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

std::string Zoltan2::IDs< gid_t, lid_t, user_t >::test_name

protected

Definition at line 674 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::passed

protected

Definition at line 675 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::print_detailed_output

protected

Definition at line 676 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::performance_test

protected

Definition at line 677 of file directoryTest_Impl.hpp.

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::IDs< gid_t, lid_t, user_t >::bUseLocalIDs

protected

Definition at line 678 of file directoryTest_Impl.hpp.

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

directoryTest_Impl.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename gid_t, typename lid_t, typename user_t> class Zoltan2::IDs< gid_t, lid_t, user_t >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename gid_t, typename lid_t, typename user_t>
class Zoltan2::IDs< gid_t, lid_t, user_t >