Compressed Row Storage (CRS) format Matrix. More...

#include <monolish_crs.hpp>

Collaboration diagram for monolish::matrix::CRS< Float >:

Public Member Functions
void	col (const size_t c, vector< Float > &vec) const
	get column vector More...

void	col (const size_t c, view1D< matrix::Dense< Float >, Float > &vec) const

void	col (const size_t c, view1D< vector< Float >, Float > &vec) const

void	compute_hash ()
	compute index array hash (to compare structure) More...

void	convert (COO< Float > &coo)
	Convert CRS matrix from COO matrix, also compute the hash. More...

void	convert (CRS< Float > &crs)
	Convert CRS matrix from COO matrix. More...

	CRS ()

	CRS (const CRS< Float > &mat)
	Create CRS matrix from CRS matrix. More...

	CRS (const CRS< Float > &mat, Float value)
	Create CRS matrix of the same size as input matrix. More...

	CRS (const size_t M, const size_t N, const size_t NNZ)
	declare CRS matrix More...

	CRS (const size_t M, const size_t N, const size_t NNZ, const int rowptr, const int colind, const Float *value)
	Create CRS matrix from array, also compute the hash. More...

	CRS (const size_t M, const size_t N, const size_t NNZ, const int rowptr, const int colind, const Float *value, const size_t origin)
	Create CRS matrix from array, also compute the hash. More...

	CRS (const size_t M, const size_t N, const std::vector< int > &rowptr, const std::vector< int > &colind, const std::vector< Float > &value)
	Create CRS matrix from std::vector, also compute the hash. More...

	CRS (const size_t M, const size_t N, const std::vector< int > &rowptr, const std::vector< int > &colind, const vector< Float > &value)
	Create CRS matrix from std::vector, also compute the hash. More...

	CRS (COO< Float > &coo)
	Create CRS matrix from COO matrix, also compute the hash. More...

void	device_free () const
	free data on GPU More...

void	diag (vector< Float > &vec) const
	get diag. vector More...

void	diag (view1D< matrix::Dense< Float >, Float > &vec) const

void	diag (view1D< vector< Float >, Float > &vec) const

bool	equal (const CRS< Float > &mat, bool compare_cpu_and_device=false) const
	Comparing matrices (A == mat) More...

void	fill (Float value)
	fill matrix elements with a scalar value More...

size_t	get_col () const
	get # of col More...

double	get_data_size () const

bool	get_device_mem_stat () const
	true: sended, false: not send More...

size_t	get_hash () const
	get index array hash (to compare structure) More...

size_t	get_nnz () const
	get # of non-zeros More...

size_t	get_row () const
	get # of row More...

void	nonfree_recv ()
	recv. data to GPU (w/o free) More...

bool	operator!= (const CRS< Float > &mat) const
	Comparing matrices (A != mat) More...

void	operator= (const CRS< Float > &mat)
	matrix copy More...

bool	operator== (const CRS< Float > &mat) const
	Comparing matrices (A == mat) More...

void	print_all (bool force_cpu=false) const
	print all elements to standard I/O More...

void	recv ()
	recv. data to GPU, and free data on GPU More...

void	row (const size_t r, vector< Float > &vec) const
	get row vector More...

void	row (const size_t r, view1D< matrix::Dense< Float >, Float > &vec) const

void	row (const size_t r, view1D< vector< Float >, Float > &vec) const

void	send () const
	send data to GPU More...

void	set_ptr (const size_t M, const size_t N, const std::vector< int > &rowptr, const std::vector< int > &colind, const std::vector< Float > &value)
	Set CRS array from std::vector. More...

void	transpose ()
	get transposed matrix (A^T) More...

void	transpose (const CRS &B)
	create transposed matrix from CRS format matrix (B = A^T) More...

std::string	type () const
	get format name "CRS" More...

	~CRS ()
	destructor of CRS matrix, free GPU memory More...

Public Attributes
std::vector< int >	col_ind
	CRS format column index, which stores column numbers of the non-zero elements (size nnz) More...

std::vector< int >	row_ptr
	CRS format row pointer, which stores the starting points of the rows of the arrays value and col_ind (size M+1) More...

std::vector< Float >	val
	CRS format value, which stores values of the non-zero elements (size nnz) More...

Private Attributes
size_t	colN
	# of col More...

bool	gpu_status = false
	true: sended, false: not send More...

size_t	nnz
	# of non-zero element More...

size_t	rowN
	# of row More...

size_t	structure_hash
	hash, created from row_ptr and col_ind More...

Detailed Description

template<typename Float>
class monolish::matrix::CRS< Float >

Compressed Row Storage (CRS) format Matrix.

Note

Multi-threading: true
GPU acceleration: true

Definition at line 34 of file monolish_crs.hpp.

Constructor & Destructor Documentation

◆ CRS() [1/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS ( )

inline

Definition at line 80 of file monolish_crs.hpp.

◆ CRS() [2/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS	(	const size_t	M,
		const size_t	N,
		const size_t	NNZ
	)

declare CRS matrix

Parameters

M	# of row
N	# of col
NNZ	# of nnz

Note

# of computation: (M+1)+2nnz
Multi-threading: false
GPU acceleration: false

◆ CRS() [3/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS	(	const size_t	M,
		const size_t	N,
		const size_t	NNZ,
		const int *	rowptr,
		const int *	colind,
		const Float *	value
	)

Create CRS matrix from array, also compute the hash.

Parameters

M	# of row
N	# of col
NNZ	# of non-zero elements
rowptr	row_ptr, which stores the starting points of the rows of the arrays value and col_ind (size M+1)
colind	col_ind, which stores the column numbers of the non-zero elements (size nnz)
value	value index, which stores the non-zero elements (size nnz)

Note

# of computation: (M+1)+2nnz + (M+1)+nnz (compute hash)
Multi-threading: false
GPU acceleration: false

◆ CRS() [4/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS	(	const size_t	M,
		const size_t	N,
		const size_t	NNZ,
		const int *	rowptr,
		const int *	colind,
		const Float *	value,
		const size_t	origin
	)

Create CRS matrix from array, also compute the hash.

Parameters

M	# of row
N	# of col
NNZ	# of non-zero elements
rowptr	row_ptr, which stores the starting points of the rows of the arrays value and col_ind (size M+1)
colind	n-origin col_ind, which stores the column numbers of the non-zero elements (size nnz)
value	value index, which stores the non-zero elements (size nnz)
origin	n-origin

Note

# of computation: (M+1)+2nnz + (M+1)+nnz (compute hash) + nnz(compute origin)
Multi-threading: false
GPU acceleration: false

◆ CRS() [5/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS	(	const size_t	M,
		const size_t	N,
		const std::vector< int > &	rowptr,
		const std::vector< int > &	colind,
		const std::vector< Float > &	value
	)

Create CRS matrix from std::vector, also compute the hash.

Parameters

M	# of row
N	# of col
rowptr	row_ptr, which stores the starting points of the rows of the arrays value and col_ind (size M+1)
colind	col_ind, which stores the column numbers of the non-zero elements (size nnz)
value	value index, which stores the non-zero elements (size nnz)

Note

# of computation: (M+1)+2nnz + (M+1)+nnz (compute hash)
Multi-threading: false
GPU acceleration: false

◆ CRS() [6/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS	(	const size_t	M,
		const size_t	N,
		const std::vector< int > &	rowptr,
		const std::vector< int > &	colind,
		const vector< Float > &	value
	)

Create CRS matrix from std::vector, also compute the hash.

Parameters

M	# of row
N	# of col
rowptr	row_ptr, which stores the starting points of the rows of the arrays value and col_ind (size M+1)
colind	col_ind, which stores the column numbers of the non-zero elements (size nnz)
value	value index, which stores the non-zero elements (size nnz)

Note

# of computation: (M+1)+2nnz + (M+1)+nnz (compute hash)
Multi-threading: false
GPU acceleration: true

◆ CRS() [7/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS ( COO< Float > & coo )

inline

Create CRS matrix from COO matrix, also compute the hash.

Parameters

coo	Source COO format matrix

Returns: coo COO format matrix

Note

Multi-threading: false
GPU acceleration: false

Definition at line 192 of file monolish_crs.hpp.

Here is the call graph for this function:

◆ CRS() [8/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS ( const CRS< Float > & mat )

Create CRS matrix from CRS matrix.

Parameters

mat	CRS format matrix

Note

# of computation: (M+1)+2nnz
Multi-threading: true
GPU acceleration: true
- # of data transfer: (M+1)+2nnz (only allocation)
  - if mat.gpu_status == true; coping data on CPU and GPU respectively
  - else; coping data only on CPU

◆ CRS() [9/9]

template<typename Float >

monolish::matrix::CRS< Float >::CRS	(	const CRS< Float > &	mat,
		Float	value
	)

Create CRS matrix of the same size as input matrix.

Parameters

mat	input CRS matrix
value	the value to initialize elements

Note

# of computation: (M+1)+2nnz
Multi-threading: true
GPU acceleration: true
- # of data transfer: (M+1)+2nnz (only allocation)
  - if mat.gpu_status == true; coping data on CPU and GPU respectively
  - else; coping data only on CPU

◆ ~CRS()

template<typename Float >

monolish::matrix::CRS< Float >::~CRS ( )

inline

destructor of CRS matrix, free GPU memory

Note

Multi-threading: false
GPU acceleration: true
- # of data transfer: 0

Definition at line 353 of file monolish_crs.hpp.

Here is the call graph for this function:

Member Function Documentation

◆ col() [1/3]

template<typename Float >

void monolish::matrix::CRS< Float >::col	(	const size_t	c,
		vector< Float > &	vec
	)		const

get column vector

Parameters

c	column number
vec	column vector

Note

# of computation: about nnz
Multi-threading: true
GPU acceleration: true

◆ col() [2/3]

template<typename Float >

void monolish::matrix::CRS< Float >::col	(	const size_t	c,
		view1D< matrix::Dense< Float >, Float > &	vec
	)		const

◆ col() [3/3]

template<typename Float >

void monolish::matrix::CRS< Float >::col	(	const size_t	c,
		view1D< vector< Float >, Float > &	vec
	)		const

◆ compute_hash()

template<typename Float >

void monolish::matrix::CRS< Float >::compute_hash ( )

compute index array hash (to compare structure)

Note

# of computation: nnz + rowN + 1
Multi-threading: true
GPU acceleration: true

◆ convert() [1/2]

template<typename Float >

void monolish::matrix::CRS< Float >::convert ( COO< Float > & coo )

Convert CRS matrix from COO matrix, also compute the hash.

Parameters

coo	COO format matrix

Note

Multi-threading: false
GPU acceleration: false

Here is the caller graph for this function:

◆ convert() [2/2]

template<typename Float >

void monolish::matrix::CRS< Float >::convert ( CRS< Float > & crs )

Convert CRS matrix from COO matrix.

Parameters

crs	CRS format matrix

Note

Multi-threading: true
GPU acceleration: false

◆ device_free()

template<typename Float >

void monolish::matrix::CRS< Float >::device_free ( ) const

free data on GPU

Note

Multi-threading: false
GPU acceleration: true
- # of data transfer: 0

Here is the caller graph for this function:

◆ diag() [1/3]

template<typename Float >

void monolish::matrix::CRS< Float >::diag ( vector< Float > & vec ) const

get diag. vector

Parameters

vec	diag. vector

Note

# of computation: M
Multi-threading: true
GPU acceleration: true

◆ diag() [2/3]

template<typename Float >

void monolish::matrix::CRS< Float >::diag ( view1D< matrix::Dense< Float >, Float > & vec ) const

◆ diag() [3/3]

template<typename Float >

void monolish::matrix::CRS< Float >::diag ( view1D< vector< Float >, Float > & vec ) const

◆ equal()

template<typename Float >

bool monolish::matrix::CRS< Float >::equal	(	const CRS< Float > &	mat,
		bool	compare_cpu_and_device = `false`
	)		const

Comparing matrices (A == mat)

Parameters

mat	CRS matrix
compare_cpu_and_device	compare data on both CPU and GPU

Returns: true or false

Note

# of computation: (M+1)+2nnz
Multi-threading: true
GPU acceleration: true

◆ fill()

template<typename Float >

void monolish::matrix::CRS< Float >::fill ( Float value )

fill matrix elements with a scalar value

Parameters

value scalar value

Note

# of computation: N
Multi-threading: true
GPU acceleration: true

◆ get_col()

template<typename Float >

size_t monolish::matrix::CRS< Float >::get_col ( ) const

inline

get # of col

Note

# of computation: 1
Multi-threading: false
GPU acceleration: false

Definition at line 266 of file monolish_crs.hpp.

◆ get_data_size()

template<typename Float >

double monolish::matrix::CRS< Float >::get_data_size ( ) const

inline

Definition at line 427 of file monolish_crs.hpp.

Here is the call graph for this function:

◆ get_device_mem_stat()

template<typename Float >

bool monolish::matrix::CRS< Float >::get_device_mem_stat ( ) const

inline

true: sended, false: not send

Returns: gpu status

Definition at line 344 of file monolish_crs.hpp.

Here is the caller graph for this function:

◆ get_hash()

template<typename Float >

size_t monolish::matrix::CRS< Float >::get_hash ( ) const

inline

get index array hash (to compare structure)

Note

# of computation: 1

Definition at line 300 of file monolish_crs.hpp.

◆ get_nnz()

template<typename Float >

size_t monolish::matrix::CRS< Float >::get_nnz ( ) const

inline

get # of non-zeros

Note

# of computation: 1
Multi-threading: false
GPU acceleration: false

Definition at line 275 of file monolish_crs.hpp.

Here is the caller graph for this function:

◆ get_row()

template<typename Float >

size_t monolish::matrix::CRS< Float >::get_row ( ) const

inline

get # of row

Note

# of computation: 1
Multi-threading: false
GPU acceleration: false

Definition at line 257 of file monolish_crs.hpp.

Here is the caller graph for this function:

◆ nonfree_recv()

template<typename Float >

void monolish::matrix::CRS< Float >::nonfree_recv ( )

recv. data to GPU (w/o free)

Note

Multi-threading: false
GPU acceleration: true
- # of data transfer: (M+1) + 2nnz

◆ operator!=()

template<typename Float >

bool monolish::matrix::CRS< Float >::operator!= ( const CRS< Float > & mat ) const

Comparing matrices (A != mat)

Parameters

mat	CRS matrix

Returns: true or false

Note

# of computation: (M+1)+2nnz
Multi-threading: true
GPU acceleration: true
- if gpu_status == true; compare data on GPU
- else; compare data on CPU

◆ operator=()

template<typename Float >

void monolish::matrix::CRS< Float >::operator= ( const CRS< Float > & mat )

matrix copy

Note

# of computation: (M+1)+2nnz
Multi-threading: true
GPU acceleration: true
- # of data transfer:
  - if gpu_status == true; coping data on GPU
  - else; coping data on CPU

◆ operator==()

template<typename Float >

bool monolish::matrix::CRS< Float >::operator== ( const CRS< Float > & mat ) const

Comparing matrices (A == mat)

Parameters

mat	CRS matrix

Returns: true or false

Note

# of computation: (M+1)+2nnz
Multi-threading: true
GPU acceleration: true
- if gpu_status == true; compare data on GPU
- else; compare data on CPU

◆ print_all()

template<typename Float >

void monolish::matrix::CRS< Float >::print_all ( bool force_cpu = false ) const

print all elements to standard I/O

Parameters

force_cpu Ignore device status and output CPU data

Note

# of computation: nnz
Multi-threading: false
GPU acceleration: false

◆ recv()

template<typename Float >

void monolish::matrix::CRS< Float >::recv ( )

recv. data to GPU, and free data on GPU

Note

Multi-threading: false
GPU acceleration: true
- # of data transfer: (M+1) + 2nnz

◆ row() [1/3]

template<typename Float >

void monolish::matrix::CRS< Float >::row	(	const size_t	r,
		vector< Float > &	vec
	)		const

get row vector

Parameters

r	row number
vec	row vector

Note

# of computation: about nnz / M
Multi-threading: true
GPU acceleration: true

◆ row() [2/3]

template<typename Float >

void monolish::matrix::CRS< Float >::row	(	const size_t	r,
		view1D< matrix::Dense< Float >, Float > &	vec
	)		const

◆ row() [3/3]

template<typename Float >

void monolish::matrix::CRS< Float >::row	(	const size_t	r,
		view1D< vector< Float >, Float > &	vec
	)		const

◆ send()

template<typename Float >

void monolish::matrix::CRS< Float >::send ( ) const

send data to GPU

Note

Multi-threading: false
GPU acceleration: true
- # of data transfer: (M+1) + 2nnz

◆ set_ptr()

template<typename Float >

void monolish::matrix::CRS< Float >::set_ptr	(	const size_t	M,
		const size_t	N,
		const std::vector< int > &	rowptr,
		const std::vector< int > &	colind,
		const std::vector< Float > &	value
	)

Set CRS array from std::vector.

Parameters

M	# of row
N	# of col
rowptr	row_ptr, which stores the starting points of the rows of the arrays value and col_ind (size M+1)
colind	col_ind, which stores the column numbers of the non-zero elements (size nnz)
value	value index, which stores the non-zero elements (size nnz)

Note

# of computation: 3
Multi-threading: false
GPU acceleration: false

◆ transpose() [1/2]

template<typename Float >

void monolish::matrix::CRS< Float >::transpose ( )

get transposed matrix (A^T)

Returns: tranposed matrix A^T

Note

# of computation: 2 * nnz + 2N
Multi-threading: false
GPU acceleration: false
need temporary CRS matrix (the same size as A)

◆ transpose() [2/2]

template<typename Float >

void monolish::matrix::CRS< Float >::transpose ( const CRS< Float > & B )

create transposed matrix from CRS format matrix (B = A^T)

Parameters

B	CRS format matrix

Note

# of computation: 2 * nnz + 2N
Multi-threading: false
GPU acceleration: false

◆ type()

template<typename Float >

std::string monolish::matrix::CRS< Float >::type ( ) const

inline

get format name "CRS"

Note

# of computation: 1
Multi-threading: false
GPU acceleration: false

Definition at line 284 of file monolish_crs.hpp.

Member Data Documentation

◆ col_ind

template<typename Float >

std::vector<int> monolish::matrix::CRS< Float >::col_ind

CRS format column index, which stores column numbers of the non-zero elements (size nnz)

Definition at line 72 of file monolish_crs.hpp.

◆ colN

template<typename Float >

size_t monolish::matrix::CRS< Float >::colN

private

# of col

Definition at line 44 of file monolish_crs.hpp.

◆ gpu_status

template<typename Float >

bool monolish::matrix::CRS< Float >::gpu_status = false

mutableprivate

true: sended, false: not send

Definition at line 54 of file monolish_crs.hpp.

◆ nnz

template<typename Float >

size_t monolish::matrix::CRS< Float >::nnz

private

# of non-zero element

Definition at line 49 of file monolish_crs.hpp.

◆ row_ptr

template<typename Float >

std::vector<int> monolish::matrix::CRS< Float >::row_ptr

CRS format row pointer, which stores the starting points of the rows of the arrays value and col_ind (size M+1)

Definition at line 78 of file monolish_crs.hpp.

◆ rowN

template<typename Float >

size_t monolish::matrix::CRS< Float >::rowN

private

# of row

Definition at line 39 of file monolish_crs.hpp.

◆ structure_hash

template<typename Float >

size_t monolish::matrix::CRS< Float >::structure_hash

private

hash, created from row_ptr and col_ind

Definition at line 59 of file monolish_crs.hpp.

◆ val

template<typename Float >

std::vector<Float> monolish::matrix::CRS< Float >::val

CRS format value, which stores values of the non-zero elements (size nnz)

Definition at line 66 of file monolish_crs.hpp.

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

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

template<typename Float> class monolish::matrix::CRS< Float >

Constructor & Destructor Documentation

◆ CRS() [1/9]

◆ CRS() [2/9]

◆ CRS() [3/9]

◆ CRS() [4/9]

◆ CRS() [5/9]

◆ CRS() [6/9]

◆ CRS() [7/9]

◆ CRS() [8/9]

◆ CRS() [9/9]

◆ ~CRS()

Member Function Documentation

◆ col() [1/3]

◆ col() [2/3]

◆ col() [3/3]

◆ compute_hash()

◆ convert() [1/2]

◆ convert() [2/2]

◆ device_free()

◆ diag() [1/3]

◆ diag() [2/3]

◆ diag() [3/3]

◆ equal()

◆ fill()

◆ get_col()

◆ get_data_size()

◆ get_device_mem_stat()

◆ get_hash()

◆ get_nnz()

◆ get_row()

◆ nonfree_recv()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ print_all()

◆ recv()

◆ row() [1/3]

◆ row() [2/3]

◆ row() [3/3]

◆ send()

◆ set_ptr()

◆ transpose() [1/2]

◆ transpose() [2/2]

◆ type()

Member Data Documentation

◆ col_ind

◆ colN

◆ gpu_status

◆ nnz

◆ row_ptr

◆ rowN

◆ structure_hash

◆ val

template<typename Float>
class monolish::matrix::CRS< Float >