Cyclops Tensor Framework
parallel arithmetic on multidimensional arrays
Public Member Functions | Data Fields
CTF::World Class Reference
CTF World interface

an instance of the CTF library (world) on a MPI communicator More...

#include <world.h>

Inheritance diagram for CTF::World:
Inheritance graph
[legend]
Collaboration diagram for CTF::World:
Collaboration graph
[legend]

Public Member Functions

 World (int argc, char *const *argv)
 creates CTF library on comm that can output profile data into a file with a name based on the main args More...
 
 World (World const &other)
 copy constructor, reallocates copies of all topologies More...
 
 World (MPI_Comm comm=MPI_COMM_WORLD, int argc=0, char *const *argv=NULL)
 creates CTF library on comm that can output profile data into a file with a name based on the main args More...
 
 World (int order, int const *lens, MPI_Comm comm=MPI_COMM_WORLD, int argc=0, char *const *argv=NULL)
 creates CTF library on comm More...
 
 World (char const *emptystring)
 substitute for default constructor that does not initialize the world More...
 
 ~World ()
 frees CTF library More...
 
bool operator== (World const &other)
 

Data Fields

MPI_Comm comm
 set of processors making up this world More...
 
int rank
 rank of local processor More...
 
int np
 number of processors More...
 
std::vector< CTF_int::topology * > topovec
 derived topologies More...
 
bool initialized
 whether the world has been initialized More...
 
CTF_int::CommData cdt
 communicator data for MPI comm defining this world More...
 
CTF_int::topology * phys_topology
 main torus topology corresponding to the world More...
 
std::mersenne_twister_engine< std::uint_fast64_t, 64, 312, 156, 31, 0xb5026f5aa96619e9, 29, 0x5555555555555555, 17, 0x71d67fffeda60000, 37, 0xfff7eee000000000, 43, 6364136223846793005 > glob_wrld_rng
 random number generator for this world object (same seed for each rank) More...
 
bool is_copy
 

Detailed Description

an instance of the CTF library (world) on a MPI communicator

Definition at line 19 of file world.h.

Constructor & Destructor Documentation

CTF::World::World ( int  argc,
char *const *  argv 
)

creates CTF library on comm that can output profile data into a file with a name based on the main args

Parameters
[in]argcnumber of main arguments
[in]argvmain arguments

Definition at line 34 of file world.cxx.

References CTF::comm, CTF_int::TOPOLOGY_BGP, CTF_int::TOPOLOGY_BGQ, and CTF_int::TOPOLOGY_GENERIC.

CTF::World::World ( World const &  other)

copy constructor, reallocates copies of all topologies

Parameters
[in]otherworld to copy

Definition at line 74 of file world.cxx.

References CTF::comm, comm, CTF_int::topology::lens, CTF_int::topology::order, phys_topology, and rank.

CTF::World::World ( MPI_Comm  comm = MPI_COMM_WORLD,
int  argc = 0,
char *const *  argv = NULL 
)

creates CTF library on comm that can output profile data into a file with a name based on the main args

Parameters
[in]commMPI communicator associated with this CTF instance
[in]argcnumber of main arguments
[in]argvmain arguments

Definition at line 49 of file world.cxx.

References CTF::comm, CTF_int::TOPOLOGY_BGP, CTF_int::TOPOLOGY_BGQ, and CTF_int::TOPOLOGY_GENERIC.

CTF::World::World ( int  order,
int const *  lens,
MPI_Comm  comm = MPI_COMM_WORLD,
int  argc = 0,
char *const *  argv = NULL 
)

creates CTF library on comm

Parameters
[in]ordernumber of torus network dimensions
[in]lenslengths of torus network dimensions
[in]commMPI global context for this CTF World
[in]argcnumber of main arguments
[in]argvmain arguments

Definition at line 65 of file world.cxx.

References CTF::comm.

CTF::World::World ( char const *  emptystring)

substitute for default constructor that does not initialize the world

Parameters
[in]emptystringshould be set to ""

Definition at line 94 of file world.cxx.

CTF::World::~World ( )

frees CTF library

Definition at line 96 of file world.cxx.

References ASSERT, CTF_SCALAPACK::cblacs_gridexit(), CTF::comm, CTF_int::get_generic_topovec(), CTF_int::get_num_instances(), CTF_int::get_phys_topo(), IASSERT, CTF_int::init_rng(), ctf.core::it, CTF_int::load_all_models(), MAX, CTF_int::mem_create(), CTF_int::mem_exit(), CTF_int::mem_size, CTF_int::mst_create(), ctf.core::np(), CTF_int::offload_exit(), CTF_int::offload_init(), CTF_int::peel_perm_torus(), CTF_int::proc_bytes_available(), ctf.core::rank(), CTF_int::scalapack_grids, CTF::set_context(), CTF::set_main_args(), CTF_int::set_mem_size(), CTF_int::set_memcap(), ctf.core::string, CTF_int::SUCCESS, TAU_FSTART, TAU_FSTOP, CTF_int::TOPOLOGY_GENERIC, CTF::universe, and VPRINTF.

Member Function Documentation

bool CTF::World::operator== ( World const &  other)
inline

Definition at line 96 of file world.h.

References comm.

Field Documentation

CTF_int::CommData CTF::World::cdt

communicator data for MPI comm defining this world

Definition at line 32 of file world.h.

Referenced by CTF::Tensor< dtype >::align(), CTF_int::tensor::compare(), CTF_int::scaling::execute(), CTF::Tensor< dtype >::fill_sp_random(), CTF_int::get_len_ordering(), CTF_int::summation::is_equal(), CTF_int::Term::operator double(), CTF_int::Term::operator float(), CTF_int::Term::operator int(), CTF_int::Term::operator int64_t(), CTF_int::tensor::orient_subworld(), CTF::Scalar< dtype >::Scalar(), CTF_int::seq_tsr_ctr::seq_tsr_ctr(), CTF_int::seq_tsr_spctr::seq_tsr_spctr(), and sparse_mp3().

MPI_Comm CTF::World::comm

set of processors making up this world

Definition at line 22 of file world.h.

Referenced by checkpoint(), CTF::Schedule::execute(), fast_tensor_ctr(), Integrals::fill_rand(), Amplitudes::fill_rand(), CTF::Matrix< dtype >::get_desc(), CTF_int::get_len_ordering(), CTF::Scalar< dtype >::get_val(), operator==(), CTF_int::tensor::orient_subworld(), CTF::Schedule::partition_and_execute(), recursive_matmul(), CTF::Tensor< dtype >::slice(), strassen(), CTF_int::summation::sum_tensors(), test_recursive_matmul(), test_subworld_gemm(), train_all(), train_world(), World(), and CTF_int::write_data_mpiio().

std::mersenne_twister_engine<std::uint_fast64_t, 64, 312, 156, 31, 0xb5026f5aa96619e9, 29, 0x5555555555555555, 17, 0x71d67fffeda60000, 37, 0xfff7eee000000000, 43, 6364136223846793005> CTF::World::glob_wrld_rng

random number generator for this world object (same seed for each rank)

Definition at line 40 of file world.h.

bool CTF::World::initialized

whether the world has been initialized

Definition at line 30 of file world.h.

bool CTF::World::is_copy

Definition at line 97 of file world.h.

Referenced by CTF::get_universe().

int CTF::World::np

number of processors

Definition at line 26 of file world.h.

Referenced by btwn_cnt(), CTF::fill_sp_random_base(), CTF::Matrix< dtype >::get_desc(), CTF_int::get_len_ordering(), CTF::Matrix< dtype >::Matrix(), CTF_int::tensor::permute(), CTF_int::read_data_mpiio(), setup_3d_Poisson(), setup_unstructured(), CTF_int::tensor::slice(), sparse_mp3(), spectral(), sptensor_sum(), and train_all().

CTF_int::topology* CTF::World::phys_topology

main torus topology corresponding to the world

Definition at line 34 of file world.h.

Referenced by World().

int CTF::World::rank

rank of local processor

Definition at line 24 of file world.h.

Referenced by apsp(), bench_ao_mo_transf(), bitonic(), bitonic_sort(), bivar_function(), bivar_transform(), block_sparse(), btwn_cnt(), btwn_cnt_fast(), checkpoint(), CTF_int::desymmetrize(), endomorphism(), endomorphism_cust(), endomorphism_cust_sp(), CTF_int::Bifun_Term::execute(), fft(), CTF::Tensor< dtype >::fill_random(), CTF::Tensor< dtype >::fill_sp_random(), CTF::fill_sp_random_base(), force_integration(), force_integration_sparse(), CTF_int::get_len_ordering(), CTF_int::summation::is_equal(), jacobi(), main(), matmul(), CTF::Matrix< dtype >::Matrix(), mis2(), neural(), CTF::Tensor< dtype >::norm1(), CTF::Tensor< dtype >::norm2(), CTF::Tensor< dtype >::norm_infty(), CTF_int::tensor::orient_subworld(), particle_interaction(), CTF::Matrix< dtype >::print_matrix(), qr(), CTF_int::read_data_mpiio(), CTF::Matrix< dtype >::read_mat(), reduce_bcast(), scan_test(), setup_3d_Poisson(), setup_unstructured(), smooth_jacobi(), sparse_checkpoint(), sparse_mp3(), spectral(), speye(), spmv(), sptensor_sum(), sssp(), CTF_int::summation::sum_tensors(), svd(), CTF::Matrix< dtype >::svd(), CTF_int::symmetrize(), CTF_int::tensor::tensor(), test_alg_multigrid(), test_ao_mo_transf(), test_mis(), test_mis2(), test_qr(), test_svd(), train_dns_vec_mat(), train_off_vec_mat(), train_sps_vec_mat(), univar_function(), vcycle(), World(), and CTF::Matrix< dtype >::write_mat().

std::vector< CTF_int::topology* > CTF::World::topovec

derived topologies

Definition at line 28 of file world.h.

Referenced by CTF_int::scaling::execute(), CTF_int::get_len_ordering(), and CTF_int::summation::is_equal().

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