Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zoltan2::IDs< gid_t, lid_t, user_t > Class Template Referenceabstract

#include <directoryTest_Impl.hpp>

Inheritance diagram for Zoltan2::IDs< gid_t, lid_t, user_t >:
Inheritance graph
[legend]

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_tupdate_user
 
std::vector< gid_t > find_gids
 
std::vector< lid_t > find_lids
 
std::vector< user_tfind_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 92 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 98 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 111 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 124 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 181 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 191 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 199 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 203 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 214 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 248 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 258 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 263 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 268 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
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
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 283 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 302 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 318 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
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
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 343 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 349 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 354 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 366 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 381 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 394 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
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 409 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
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
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
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
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
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
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
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 460 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 469 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
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 540 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 605 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 613 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 623 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 624 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 625 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 627 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 628 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 629 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 630 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 631 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 632 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 633 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 634 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 635 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 636 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 637 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 638 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 639 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 640 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 641 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 642 of file directoryTest_Impl.hpp.


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