NTPoly::DistributedSparseMatrix Class Reference

A Module For Performing Distributed Sparse Matrix Operations. More...

#include <DistributedSparseMatrix.h>

Public Member Functions
	DistributedSparseMatrix (int matrix_dimension)
	DistributedSparseMatrix (std::string file_name, bool is_binary=false)
	DistributedSparseMatrix (const DistributedSparseMatrix &matB)
void	WriteToBinary (std::string file_name) const
void	WriteToMatrixMarket (std::string file_name) const
void	FillFromTripletList (const TripletList &triplet_list)
void	FillDistributedPermutation (const Permutation &lb, bool permuterows=true)
void	FillIdentity ()
	Fills this matrix as the identity matrix.
int	GetActualDimension () const
	get the actual dimension of the matrix.
int	GetLogicalDimension () const
	the logical dimension is scaled so each process has an even slice.
double	Dot (const DistributedSparseMatrix &matB)
void	Increment (const DistributedSparseMatrix &matB, double alpha=1.0, double threshold=0.0)
void	PairwiseMultiply (const DistributedSparseMatrix &matA, const DistributedSparseMatrix &matB)
void	Gemm (const DistributedSparseMatrix &matA, const DistributedSparseMatrix &matB, DistributedMatrixMemoryPool &memory_pool, double alpha=1.0, double beta=0.0, double threshold=0.0)
void	Scale (double constant)
double	Norm () const
	compute the norm of a matrix.
double	Trace () const
	compute the trace of a matrix.
	~DistributedSparseMatrix ()
	Destructor.

Friends
class	LoadBalancer
class	SolverBase
class	TripletList

Detailed Description

A Module For Performing Distributed Sparse Matrix Operations.

Constructor & Destructor Documentation

DistributedSparseMatrix() [1/3]

NTPoly::DistributedSparseMatrix::DistributedSparseMatrix

(

int

matrix_dimension

)

Construct an empty matrix.

Parameters

matrix_dimension

size fo the matrix.

DistributedSparseMatrix() [2/3]

NTPoly::DistributedSparseMatrix::DistributedSparseMatrix	(	std::string	file_name,
		bool	is_binary = false
	)

Construct a matrix from file.

Parameters

file_name	name of the file to build from.
is_binary	true if the file is a binary file.

DistributedSparseMatrix() [3/3]

NTPoly::DistributedSparseMatrix::DistributedSparseMatrix

(

const DistributedSparseMatrix &

matB

)

Copy constructor.

Parameters

matB	matrix to opy from.

Member Function Documentation

Dot()

double NTPoly::DistributedSparseMatrix::Dot

(

const DistributedSparseMatrix &

matB

)

this = dot(this,matB)

Parameters

matB	the matrix to dot.

FillDistributedPermutation()

void NTPoly::DistributedSparseMatrix::FillDistributedPermutation	(	const Permutation &	lb,
		bool	permuterows = true
	)

Fill the matrix based on a permutation.

Parameters

lb	the permutation.
permuterows	true if this is a row permutation matrix.

FillFromTripletList()

void NTPoly::DistributedSparseMatrix::FillFromTripletList

(

const TripletList &

triplet_list

)

Fill in the matrix based on the contents of triplet lists.

Parameters

triplet_list

list of values. Need to be absolute coordinates.

Gemm()

void NTPoly::DistributedSparseMatrix::Gemm	(	const DistributedSparseMatrix &	matA,
		const DistributedSparseMatrix &	matB,
		DistributedMatrixMemoryPool &	memory_pool,
		double	alpha = 1.0,
		double	beta = 0.0,
		double	threshold = 0.0
	)

this := alpha*matA*matB+ beta*this (GEMM)

Parameters

matA	first mat.
matB	second mat.
memory_pool	memory pool for intermediates.
alpha	scaling factor.
beta	scaling factor.
threshold	for flushing small values.

Increment()

void NTPoly::DistributedSparseMatrix::Increment	(	const DistributedSparseMatrix &	matB,
		double	alpha = 1.0,
		double	threshold = 0.0
	)

this = alpha*MatB + this (AXPY)

Parameters

matB	the matrix to add.
alpha	scaling factor.
threshold	for flushing small values.

PairwiseMultiply()

void NTPoly::DistributedSparseMatrix::PairwiseMultiply	(	const DistributedSparseMatrix &	matA,
		const DistributedSparseMatrix &	matB
	)

Pairwise multiply two matrices.

Parameters

matA	first mat.
matB	second mat.

Scale()

void NTPoly::DistributedSparseMatrix::Scale

(

double

constant

)

scale the matrix by a constatn. constant the value to scale by.

WriteToBinary()

void NTPoly::DistributedSparseMatrix::WriteToBinary

(

std::string

file_name

)

const

Write the matrix to a custom binary format.

Parameters

file_name

file to write to.

WriteToMatrixMarket()

void NTPoly::DistributedSparseMatrix::WriteToMatrixMarket

(

std::string

file_name

)

const

Write the matrix to the matrix market format.

Parameters

file_name

file to write to.

---

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

• /Users/dawson/Documents/SparseMatrix/NTPoly/Source/CPlusPlus/DistributedSparseMatrix.h
• /Users/dawson/Documents/SparseMatrix/NTPoly/Source/CPlusPlus/DistributedSparseMatrix.cc