rabit-inl.h File Reference

implementation of inline template function for rabit interface More...

#include <vector>
#include <string>
#include "rabit/internal/io.h"
#include "rabit/internal/utils.h"
#include "rabit/rabit.h"

Go to the source code of this file.

Data Structures
class	rabit::op::Max
	maximum reduction operator More...
class	rabit::op::Min
	minimum reduction operator More...
class	rabit::op::Sum
	sum reduction operator More...
class	rabit::op::BitAND
	bitwise AND reduction operator More...
class	rabit::op::BitOR
	bitwise OR reduction operator More...
class	rabit::op::BitXOR
	bitwise XOR reduction operator More...

Namespaces
namespace	rabit
	namespace of rabit
namespace	rabit::engine
	core interface of the engine
namespace	rabit::engine::mpi
	namespace that contains stubs to be compatible with MPI
namespace	rabit::op
	reduction operators namespace

Functions
template<typename DType >
DataType	rabit::engine::mpi::GetType ()
template<>
DataType	rabit::engine::mpi::GetType< char > ()
template<>
DataType	rabit::engine::mpi::GetType< unsigned char > ()
template<>
DataType	rabit::engine::mpi::GetType< int > ()
template<>
DataType	rabit::engine::mpi::GetType< unsigned int > ()
template<>
DataType	rabit::engine::mpi::GetType< long > ()
template<>
DataType	rabit::engine::mpi::GetType< unsigned long > ()
template<>
DataType	rabit::engine::mpi::GetType< float > ()
template<>
DataType	rabit::engine::mpi::GetType< double > ()
template<>
DataType	rabit::engine::mpi::GetType< long long > ()
template<>
DataType	rabit::engine::mpi::GetType< unsigned long long > ()
template<typename OP , typename DType >
void	rabit::op::Reducer (const void *src_, void *dst_, int len, const MPI::Datatype &)
bool	rabit::Init (int argc, char *argv[])
	initializes rabit, call this once at the beginning of your program
bool	rabit::Finalize ()
	finalizes the rabit engine, call this function after you finished with all the jobs
int	rabit::GetRingPrevRank ()
int	rabit::GetRank ()
	gets rank of the current process
int	rabit::GetWorldSize ()
	gets total number of processes
bool	rabit::IsDistributed ()
	whether rabit env is in distributed mode
std::string	rabit::GetProcessorName ()
	gets processor's name
void	rabit::Broadcast (void *sendrecv_data, size_t size, int root)
	broadcasts a memory region to every node from the root
template<typename DType >
void	rabit::Broadcast (std::vector< DType > *sendrecv_data, int root)
	broadcasts an std::vector<DType> to every node from root
void	rabit::Broadcast (std::string *sendrecv_data, int root)
	broadcasts a std::string to every node from the root
template<typename OP , typename DType >
void	rabit::Allreduce (DType *sendrecvbuf, size_t count, void(*prepare_fun)(void *arg), void *prepare_arg)
void	rabit::TrackerPrint (const std::string &msg)
	prints the msg to the tracker, this function can be used to communicate progress information to the user who monitors the tracker
void	rabit::TrackerPrintf (const char *fmt,...)
	prints the msg to the tracker, this function may not be available in very strict c++98 compilers, though it usually is. this function can be used to communicate progress information to the user who monitors the tracker
int	rabit::LoadCheckPoint ()
	deprecated, planned for removal after checkpoing from JVM package is removed.
void	rabit::CheckPoint ()
	deprecated, planned for removal after checkpoing from JVM package is removed.
int	rabit::VersionNumber ()

Detailed Description

implementation of inline template function for rabit interface

Copyright (c) 2014-2019 by Contributors

Author

Tianqi Chen