sparsematrixmodule_wrp Module Reference

A module for wrapping the sparse matrix data type. More...

Data Types
type	sparsematrix_wrp
	A wrapper for the sparse matrix data type. More...

Functions/Subroutines
pure subroutine, public	constructemptysparsematrix_wrp (ih_this, columns, rows)
	Wrap the empty sparse matrix constructor. More...
subroutine, public	constructsparsematrixfromfile_wrp (ih_this, file_name, name_size)
	Create a sparse matrix by reading in a matrix market file. More...
pure subroutine, public	constructfromtripletlist_wrp (ih_this, ih_triplet_list, rows, columns)
	Construct a sparse matrix from a SORTED triplet list. More...
pure subroutine, public	destructsparsematrix_wrp (ih_this)
	Explicitly destruct a sparse matrix. More...
pure subroutine, public	copysparsematrix_wrp (ih_matA, ih_matB)
	Wrap the copy a sparse matrix routine. More...
pure subroutine, public	getrows_wrp (ih_this, rows)
	Wrap the row accessor. More...
pure subroutine, public	getcolumns_wrp (ih_this, columns)
	Wrap the column accessor. More...
pure subroutine, public	transposesparsematrix_wrp (ih_matA, ih_matAT)
	Wrap the matrix transpose function. More...
subroutine, public	printsparsematrixf_wrp (ih_this, file_name, name_size)
	Warp the routine that prints out a sparse matrix to file. More...
subroutine, public	printsparsematrix_wrp (ih_this)
	Warp the routine that prints the sparse matrix to the console. More...
subroutine, public	matrixtotripletlist_wrp (ih_this, ih_triplet_list)
	Wrap the routine that constructs a triplet list from a matrix. More...

Detailed Description

A module for wrapping the sparse matrix data type.

Function/Subroutine Documentation

constructemptysparsematrix_wrp()

pure subroutine, public sparsematrixmodule_wrp::constructemptysparsematrix_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_this,
		integer(kind=c_int), intent(in)	columns,
		integer(kind=c_int), intent(in)	rows
	)

Wrap the empty sparse matrix constructor.

Parameters

[out]	ih_this	handle to the matrix being created.
[in]	columns	number of matrix columns.
[in]	rows	number of matrix rows.

constructfromtripletlist_wrp()

pure subroutine, public sparsematrixmodule_wrp::constructfromtripletlist_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_this,
		integer(kind=c_int), dimension(size_wrp), intent(in)	ih_triplet_list,
		integer(kind=c_int), intent(in)	rows,
		integer(kind=c_int), intent(in)	columns
	)

Construct a sparse matrix from a SORTED triplet list.

Parameters

[in,out]	ih_this	handle to the matrix being constructed
[in]	ih_triplet_list	handle to a sorted list of triplet values
[in]	rows	number of matrix rows
[in]	columns	number of matrix columns

constructsparsematrixfromfile_wrp()

subroutine, public sparsematrixmodule_wrp::constructsparsematrixfromfile_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_this,
		character(kind=c_char), dimension(name_size), intent(in)	file_name,
		integer(kind=c_int), intent(in)	name_size
	)

Create a sparse matrix by reading in a matrix market file.

Parameters

[out]	ih_this	the matrix being constructed.
[in]	file_name	name of the file.
[in]	name_size	the number of characters in the file name.

copysparsematrix_wrp()

pure subroutine, public sparsematrixmodule_wrp::copysparsematrix_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_matA,
		integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_matB
	)

Wrap the copy a sparse matrix routine.

Parameters

[in]	ih_matA	handle to the matrix to copy
[in,out]	ih_matB	matB = matA

destructsparsematrix_wrp()

pure subroutine, public sparsematrixmodule_wrp::destructsparsematrix_wrp

(

integer(kind=c_int), dimension(size_wrp), intent(inout)

ih_this

)

Explicitly destruct a sparse matrix.

Parameters

[in,out]

ih_this

handle to the matrix to free up.

getcolumns_wrp()

pure subroutine, public sparsematrixmodule_wrp::getcolumns_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_this,
		integer(kind=c_int), intent(out)	columns
	)

Wrap the column accessor.

Parameters

[in]	ih_this	handle to the matrix.
[out]	columns	the number of columns.

getrows_wrp()

pure subroutine, public sparsematrixmodule_wrp::getrows_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_this,
		integer(kind=c_int), intent(out)	rows
	)

Wrap the row accessor.

Parameters

[in]	ih_this	handle to the matrix.
[out]	rows	the number of rows.

matrixtotripletlist_wrp()

subroutine, public sparsematrixmodule_wrp::matrixtotripletlist_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_this,
		integer(kind=c_int), dimension(size_wrp), intent(out)	ih_triplet_list
	)

Wrap the routine that constructs a triplet list from a matrix.

Parameters

[in]	ih_this	handle to the matrix to construct the triplet list from
[out]	ih_triplet_list	handle to the triplet list we created.

printsparsematrix_wrp()

subroutine, public sparsematrixmodule_wrp::printsparsematrix_wrp

(

integer(kind=c_int), dimension(size_wrp), intent(in)

ih_this

)

Warp the routine that prints the sparse matrix to the console.

Parameters

[in]

ih_this

the matrix to be printed.

printsparsematrixf_wrp()

subroutine, public sparsematrixmodule_wrp::printsparsematrixf_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_this,
		character(kind=c_char), dimension(name_size), intent(in)	file_name,
		integer(kind=c_int), intent(in)	name_size
	)

Warp the routine that prints out a sparse matrix to file.

Parameters

[in]	ih_this	the matrix to be printed.
[in]	file_name	optionally, you can pass a file to print to.
[in]	name_size	the number of characters in the file name.

transposesparsematrix_wrp()

pure subroutine, public sparsematrixmodule_wrp::transposesparsematrix_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_matA,
		integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_matAT
	)

Wrap the matrix transpose function.

Parameters

[in]	ih_matA	handle to the matrix to be transposed.
[in,out]	ih_matAT	handle to the the input matrix transposed.