Block< Matrix > Struct Template Reference

Detailed Description

template<class Matrix>
struct shogun::linalg::Block< Matrix >

Generic class Block which wraps a matrix class and contains block specific information, providing a uniform way to deal with matrix blocks for all supported backend matrices.

Definition at line 49 of file Block.h.

Public Types
typedef Matrix::Scalar	Scalar

Public Member Functions
	Block (Matrix matrix, index_t row_begin, index_t col_begin, index_t row_size, index_t col_size)

Public Attributes
Matrix	m_matrix
index_t	m_row_begin
index_t	m_col_begin
index_t	m_row_size
index_t	m_col_size

Member Typedef Documentation

typedef Matrix::Scalar Scalar

scalar type

Definition at line 52 of file Block.h.

Constructor & Destructor Documentation

Block	(	Matrix	matrix,
		index_t	row_begin,
		index_t	col_begin,
		index_t	row_size,
		index_t	col_size
	)

constructor

Parameters

matrix	the matrix on which the block is defined
row_begin	the row index at which the block starts
col_begin	the col index at which the block starts
row_size	the number of rows in the block
col_size	the number of cols in the block

For example, row_begin 0, col_begin 4 and row_size 5, col_size 6 represents the block that starts at index (0,4) in the matrix and goes upto (0+5-1,4+6-1) i.e. (4,9) both inclusive

Definition at line 67 of file Block.h.

Member Data Documentation

index_t m_col_begin

the col index at which the block starts

Definition at line 82 of file Block.h.

index_t m_col_size

the number of cols in the block

Definition at line 88 of file Block.h.

Matrix m_matrix

the matrix on which the block is defined

Definition at line 76 of file Block.h.

index_t m_row_begin

the row index at which the block starts

Definition at line 79 of file Block.h.

index_t m_row_size

the number of rows in the block

Definition at line 85 of file Block.h.

---

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

• Block.h