dist_matrix< A > Class Template Reference

A template class for handling matrix distributed on processors. More...

#include <dist_matrix.h>

Collaboration diagram for dist_matrix< A >:

[legend]List of all members.

Public Member Functions
	dist_matrix ()
	Default constructor.
	dist_matrix (int nn, int mm, const SKEL_MPI_INTRACOMM &com=SKEL_MPI_COMM_WORLD, int r=-1, int c=-1)
	constructor specifying its shape but elements.
template<typename F>
	dist_matrix (int nn, int mm, const F &f, const SKEL_MPI_INTRACOMM &com=SKEL_MPI_COMM_WORLD, int r=-1, int c=-1)
	Constructor with generator function.
	dist_matrix (const matrix< A > *mat, const SKEL_MPI_INTRACOMM &com=SKEL_MPI_COMM_WORLD, int r=-1, int c=-1)
	Constructor with distributing root's local matrix.
	dist_matrix (const dist_matrix< A > &dmat)
	Copy Constructor.
	~dist_matrix ()
	A destructor.
template<typename F>
void	generate (const F &f)
	Generate elements by generator function.
void	distribute (const matrix< A > *mat)
	Distribute a matrix at root process.
void	gather (matrix< A > *mat) const
	Gather block-matrices distributed to processors into a matrix.
void	gatherB (matrix< A > *mat) const
	Gather with broadcast.
void	print (std::ostream &os) const
	Print whole matrix to output-stream in root process.
template<typename B>
void	shapeCopy (const dist_matrix< B > *mat)
	Shape copy.
int	getRows () const
	The number of rows of total matrix.
int	getCols () const
	The number of columns of total matrix.
int	getLocalRows () const
	The number of rows of local submatrix.
int	getLocalCols () const
	The number of columns of local submatrix.
int	getBlocksInRow () const
	The number of submatrices in rows.
int	getBlocksInCol () const
	the number of submatrices in columns.
int	getIdxRow () const
	Global row-index of upper-left element of this matrix.
int	getIdxCol () const
	Global column-index of upper-left element of this matrix.
int	getPosX () const
	Global x position of this submatrix.
int	getPosY () const
	Global y position of this submatrix.
A &	get (int i, int j) const
	Return reference of the element at (i, j) of local submatrix.
A &	at (int i, int j)
	Return reference of the element at (i, j) of local submatrix.
const A &	at (int i, int j) const
	Return const reference of the element at (i, j) of local submatrix.
void	set (int i, int j, const A &v)
	Put value v at (i, j) of local submatrix.
int	getRank () const
	Rank of this process.
matrix< A > *	getMatrix () const
	Return elements of this dist_matrix as an object of matrix.
const MPI_Datatype &	getType () const
	MPI datatype of elements.
A *	globalGet (int i, int j) const
	get an element at (i, j) of global index of the matrix.
void	globalSet (int i, int j, const A &val) const
	set an element at (i, j) of global index of the matrix.
Static Public Member Functions
template<typename B>
static void	bcast (B *res, const dist_matrix< A > *mat)
	broadcast (from root to the other processes).
Friends
class	matrix_skeletons

---

Detailed Description

template<typename A>
class dist_matrix< A >

A template class for handling matrix distributed on processors.

The matrix is consists of three constructors 'abv'(above), 'bsd'(beside) and 'sing'(singleton). So, in haskell notation, datatype matrix is as follows:

 data Matrix a = Sing a
         | Abv (Matrix a) (Matrix a)
         | Bsd (Matrix a) (Matrix a)

A singleton matrix with an element E is 'Sing E' or '|E|' for brevity. A matrix made by placing matrix B on the left of matrix C is 'Bsd B C' or 'B `Bsd` C'. The heights of B and C should be the same. A matrix made by placing matrix B on the top of matrix C is 'Abv B C' or 'B `Abv` C'. The widths of B and C should be the same. The constructors 'Bsd' and 'Abv' are associative and have abiding property: '(B `Bsd` C) `Abv` (E `Bsd` F) = (B `Abv` E) `Bsd` (C `Abv` F)'. Skeletons are defined as recursive functions on the structure. Indices are starting from 0.

See also:

matrix

Definition at line 108 of file dist_matrix.h.

---

Constructor & Destructor Documentation

template<typename A> dist_matrix< A >::dist_matrix (   )

Default constructor. This constructor do nothing.

template<typename A> dist_matrix< A >::dist_matrix (  int  nn, int  mm, const SKEL_MPI_INTRACOMM &  com = SKEL_MPI_COMM_WORLD, int  r = -1, int  c = -1 )

constructor specifying its shape but elements. The number of processors to be used is r * c. If r or c is less than 0 (default), then r and c are calcuated by distribution policy which can be specified by matrix_skeletons. r * c should not exceed the total number of processors. Parameters: nn  the number of rows of global matrix. mm  the number of columns of global matrix. com  The communicator to handle this matrix. r  the number of partitions in rows. c  the number of partitions in columns. The parameters nn, mm, r and c are ignored in processors of which ranks are greater than 0.

template<typename A> template<typename F> dist_matrix< A >::dist_matrix (  int  nn, int  mm, const F &  f, const SKEL_MPI_INTRACOMM &  com = SKEL_MPI_COMM_WORLD, int  r = -1, int  c = -1 )

Constructor with generator function. The number of processors to be used is r * c. If r or c is less than 0 (default), then r and c are calcuated by distribution policy which can be specified by matrix_skeletons. r * c should not exceed the total number of processors. Parameters: nn  the number of rows of global matrix. mm  the number of columns of global matrix. com  The communicator to handle this matrix. r  the number of partitions in rows. c  the number of partitions in columns. f  the generator function object. the value of element at (i, j) is initialized with f (i, j). f should have a member void f(int i, int j, A *r) const. A sample of function object is as follows: (the value of element at (i, j) is i + j) class Gen { public: void operator()(int i, int j, A *r) const { *r = i + j; } }; The parameters @a nn, @a mm, @a r and @a c are ignored in processors of which ranks are greater than 0.

template<typename A> dist_matrix< A >::dist_matrix (  const matrix< A > *  mat, const SKEL_MPI_INTRACOMM &  com = SKEL_MPI_COMM_WORLD, int  r = -1, int  c = -1 )

Constructor with distributing root's local matrix. The number of processors to be used is r * c. If r or c is less than 0 (default), then r and c are calcuated by distribution policy which can be specified by matrix_skeletons. r * c should not exceed the total number of processors. Parameters: mat  matrix on root process to be distributed. com  The communicator to handle this matrix. r  the number of partitions in rows. c  the number of partitions in columns. The parameters r and c are ignored in processors of which ranks are greater than 0.

template<typename A> dist_matrix< A >::dist_matrix (  const dist_matrix< A > &  dmat  )

Copy Constructor.

template<typename A> dist_matrix< A >::~dist_matrix (   )

A destructor.

---

Member Function Documentation

template<typename A> const A& dist_matrix< A >::at (  int  i, int  j )  const [inline]

Return const reference of the element at (i, j) of local submatrix. Parameters: i  row-index of the element. j  column-index of the element. Definition at line 465 of file dist_matrix.h.

template<typename A> A& dist_matrix< A >::at (  int  i, int  j )  [inline]

Return reference of the element at (i, j) of local submatrix. Parameters: i  row-index of the element. j  column-index of the element. Definition at line 458 of file dist_matrix.h.

template<typename A> template<typename B> static void dist_matrix< A >::bcast (  B *  res, const dist_matrix< A > *  mat )  [static]

broadcast (from root to the other processes). This function usually used to broadcast results of recude skeletons. For example, to divide all elements by their summation, we use reduce-skeleton with addition-operators to get the summation 'S', broadcast it by this bcast, and apply map-skeleton with a function '( / S)' to the matrix. Parameters: res  the value to be broadcasted in root process, the received value in other processes. mat  a dist_matrix used to determine members of broadcasting.

template<typename A> void dist_matrix< A >::distribute (  const matrix< A > *  mat  )

Distribute a matrix at root process. Arguments of other process are ignored. Parameters: mat  a matrix to be distributed.

template<typename A> void dist_matrix< A >::gather (  matrix< A > *  mat  )  const

Gather block-matrices distributed to processors into a matrix. The whole matrix is stored in the root process. The arguments of other process are unknown. Parameters: mat  a matrix to which the whole matrix is stored.

template<typename A> void dist_matrix< A >::gatherB (  matrix< A > *  mat  )  const

Gather with broadcast. This function gather the block-matrices distributed to processors into a matrix. The resulting matrix is broadcasted among all processors. Parameters: mat  a matrix to which the whole matrix is stored. See also: gather(matrix<A> &)

template<typename A> template<typename F> void dist_matrix< A >::generate (  const F &  f  )

Generate elements by generator function. Parameters: f  the generator function object. the value of element at (i, j) is initialized with f (i, j). f should have a member void f(int i, int j, A *r) const. A sample of function object is as follows: (the value of element at (i, j) is i + j) class Gen { public: void operator()(int i, int j, int *r) const { *r = i + j; } };

template<typename A> A& dist_matrix< A >::get (  int  i, int  j )  const [inline]

Return reference of the element at (i, j) of local submatrix. Parameters: i  row-index of the element. j  column-index of the element. Definition at line 451 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getBlocksInCol (   )  const [inline]

the number of submatrices in columns. Definition at line 428 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getBlocksInRow (   )  const [inline]

The number of submatrices in rows. Definition at line 424 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getCols (   )  const [inline]

The number of columns of total matrix. Definition at line 412 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getIdxCol (   )  const [inline]

Global column-index of upper-left element of this matrix. Definition at line 436 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getIdxRow (   )  const [inline]

Global row-index of upper-left element of this matrix. Definition at line 432 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getLocalCols (   )  const [inline]

The number of columns of local submatrix. Definition at line 420 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getLocalRows (   )  const [inline]

The number of rows of local submatrix. Definition at line 416 of file dist_matrix.h.

template<typename A> matrix<A>* dist_matrix< A >::getMatrix (   )  const [inline]

Return elements of this dist_matrix as an object of matrix. Definition at line 481 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getPosX (   )  const [inline]

Global x position of this submatrix. Definition at line 440 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getPosY (   )  const [inline]

Global y position of this submatrix. Definition at line 444 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getRank (   )  const [inline]

Rank of this process. Definition at line 477 of file dist_matrix.h.

template<typename A> int dist_matrix< A >::getRows (   )  const [inline]

The number of rows of total matrix. Definition at line 408 of file dist_matrix.h.

template<typename A> const MPI_Datatype& dist_matrix< A >::getType (   )  const [inline]

MPI datatype of elements. Users usually should not use this function. Definition at line 487 of file dist_matrix.h.

template<typename A> A* dist_matrix< A >::globalGet (  int  i, int  j )  const

get an element at (i, j) of global index of the matrix. This function returns a value of the element at (i, j) wherever the element is stored. The result is broadcasted to all processes. User should free the resulting pointer. Parameters: i  row-index of the element j  coljmn-index of the element

template<typename A> void dist_matrix< A >::globalSet (  int  i, int  j, const A &  val )  const

set an element at (i, j) of global index of the matrix. This function puts a value in root process into an element at (i, j) wherever the element is stored. Parameters: i  row-index of the element j  coljmn-index of the element val  the value to be put (the value is ignored in all processes except the root)

template<typename A> void dist_matrix< A >::print (  std::ostream &  os  )  const

Print whole matrix to output-stream in root process. This function gathers distributed matrix and outputs it to the output stream of root process. Parameters: os  output-stream to which the matrix is output.

template<typename A> void dist_matrix< A >::set (  int  i, int  j, const A &  v )  [inline]

Put value v at (i, j) of local submatrix. Parameters: i  row-index of the element. j  column-index of the element. v  the value to be stored. Definition at line 473 of file dist_matrix.h.

template<typename A> template<typename B> void dist_matrix< A >::shapeCopy (  const dist_matrix< B > *  mat  )

Shape copy. Shape (size of matrix and the distribution pattern) is copied from the argument matrix mat. Parameters: mat  dist_matrix to be copied (shape only).

---

Friends And Related Function Documentation

template<typename A> friend class matrix_skeletons [friend]

The skeletons. Definition at line 110 of file dist_matrix.h.

---

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

• libraries/matrix/dist_matrix.h

---