CUSP
Loading...
Searching...
No Matches
Public Methods | Public Members | List of all members
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace > Class Template Reference
Sparse Matrices » Sparse Matrix Views

#include <hyb_matrix.h>

Inheritance diagram for cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >:

Public Methods

 hyb_matrix_view (void)
 
template<typename OtherMatrixType1 , typename OtherMatrixType2 >
 hyb_matrix_view (OtherMatrixType1 &ell, OtherMatrixType2 &coo)
 
template<typename OtherMatrixType1 , typename OtherMatrixType2 >
 hyb_matrix_view (const OtherMatrixType1 &ell, const OtherMatrixType2 &coo)
 
 hyb_matrix_view (hyb_matrix< IndexType, ValueType, MemorySpace > &matrix)
 
 hyb_matrix_view (const hyb_matrix< IndexType, ValueType, MemorySpace > &matrix)
 
 hyb_matrix_view (hyb_matrix_view &matrix)
 
 hyb_matrix_view (const hyb_matrix_view &matrix)
 
void resize (size_t num_rows, size_t num_cols, size_t num_ell_entries, size_t num_coo_entries, size_t num_entries_per_row, size_t alignment=32)
 

Public Members

ell_matrix_type ell
 
coo_matrix_type coo
 

Detailed description

template<typename MatrixType1, typename MatrixType2, typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
class cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >

View of a hyb_matrix.

Template Parameters
MatrixType1Type of ell
MatrixType2Type of coo
IndexTypeType used for matrix indices (e.g. int).
ValueTypeType used for matrix values (e.g. float).
MemorySpaceA memory space (e.g. cusp::host_memory or cusp::device_memory)
Overview
A hyb_matrix_view is a sparse matrix view of a hyb_matrix constructed from existing data or iterators. See ell_matrix and coo_matrix for format constraints.
Note
The matrix entries must be sorted by row index.
The matrix should not contain duplicate entries.
Example
The following code snippet demonstrates how to create a 4-by-3 hyb_matrix_view on the host with 6 nonzeros.
// include coo_matrix header file
#include <cusp/hyb_matrix.h>
#include <cusp/print.h>
int main()
{
typedef cusp::ell_matrix<int,float,cusp::host_memory>::view EllMatrixView;
typedef cusp::coo_matrix<int,float,cusp::host_memory>::view CooMatrixView;
// allocate storage for (4,3) matrix with 8 nonzeros
// ELL portion has 5 nonzeros and storage for 2 nonzeros per row
// COO portion has 3 nonzeros
cusp::ell_matrix<int,float,cusp::host_memory> ell(4,3,5,2);
cusp::coo_matrix<int,float,cusp::host_memory> coo(4,3,3);
// Initialize A to represent the following matrix
// [10 20 30 40]
// [ 0 50 0 0]
// [60 0 70 80]
// A is split into ELL and COO parts as follows
// [10 20 30 40] [10 20 0 0] [ 0 0 30 40]
// [ 0 50 0 0] = [ 0 50 0 0] + [ 0 0 0 0]
// [60 0 70 80] [60 0 70 0] [ 0 0 0 80]
// Initialize ELL part
// X is used to fill unused entries in the ELL portion of the matrix
const int X = cusp::ell_matrix<int,float,cusp::host_memory>::invalid_index;
// first row
ell.column_indices(0,0) = 0; ell.values(0,0) = 10;
ell.column_indices(0,1) = 1; ell.values(0,1) = 20;
// second row
ell.column_indices(1,0) = 1; ell.values(1,0) = 50; // shifted to leftmost position
ell.column_indices(1,1) = X; ell.values(1,1) = 0; // padding
// third row
ell.column_indices(2,0) = 0; ell.values(2,0) = 60;
ell.column_indices(2,1) = 2; ell.values(2,1) = 70; // shifted to leftmost position
// Initialize COO part
coo.row_indices[0] = 0; coo.column_indices[0] = 2; coo.values[0] = 30;
coo.row_indices[1] = 0; coo.column_indices[1] = 3; coo.values[1] = 40;
coo.row_indices[2] = 2; coo.column_indices[2] = 3; coo.values[2] = 80;
// allocate storage for (4,3) matrix with 6 nonzeros
cusp::hyb_matrix_view<EllMatrixView,CooMatrixView>
A(cusp::make_ell_matrix_view(ell),
cusp::make_coo_matrix_view(coo));
// print the constructed hyb_matrix
cusp::print(A);
// change first entry in values array
ell.values(0,0) = -1;
// print the updated matrix view
cusp::print(A);
}
cusp::coo_matrix
Coordinate (COO) representation a sparse matrix.
Definition coo_matrix.h:117
cusp::ell_matrix
Packed row (ELLPACK/ITPACK) representation of a sparse matrix.
Definition ell_matrix.h:120
cusp::ell_matrix::column_indices
column_indices_array_type column_indices
Definition ell_matrix.h:165
cusp::hyb_matrix_view
View of a hyb_matrix.
Definition hyb_matrix.h:349
cusp::hyb_matrix_view::ell
ell_matrix_type ell
Definition hyb_matrix.h:376
cusp::hyb_matrix_view::coo
coo_matrix_type coo
Definition hyb_matrix.h:380
cusp::print
void print(const Printable &p)
print a textual representation of an object
cusp::make_ell_matrix_view
ell_matrix_view< ArrayType1, ArrayType2 > make_ell_matrix_view(size_t num_rows, size_t num_cols, size_t num_entries, ArrayType1 column_indices, ArrayType2 values)
Definition ell_matrix.h:458
cusp::make_coo_matrix_view
coo_matrix_view< ArrayType1, ArrayType2, ArrayType3 > make_coo_matrix_view(const size_t num_rows, const size_t num_cols, const size_t num_entries, ArrayType1 row_indices, ArrayType2 column_indices, ArrayType3 values)
Definition coo_matrix.h:524
hyb_matrix.h
Hybrid ELL/COO matrix format.
print.h
Print textual representation of an object.

Definition at line 348 of file hyb_matrix.h.

Constructor & Destructor Documentation

◆ hyb_matrix_view() [1/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( void  )
inline

Construct an empty hyb_matrix_view.

Definition at line 384 of file hyb_matrix.h.

◆ hyb_matrix_view() [2/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
template<typename OtherMatrixType1 , typename OtherMatrixType2 >
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( OtherMatrixType1 &  ell,
OtherMatrixType2 &  coo 
)
inline

Construct a hyb_matrix_view with a specific shape and number of nonzero entries from existing ell_matrix and coo_matrix matrices.

Template Parameters
OtherMatrixType1Type of ell_matrix used to construct view
OtherMatrixType2Type of coo_matrix used to construct view
Parameters
ellMatrix containing ELL portion of hyb_format.
cooMatrix containing COO portion of hyb_format.

Definition at line 396 of file hyb_matrix.h.

◆ hyb_matrix_view() [3/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
template<typename OtherMatrixType1 , typename OtherMatrixType2 >
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( const OtherMatrixType1 &  ell,
const OtherMatrixType2 &  coo 
)
inline

Construct a hyb_matrix_view with a specific shape and number of nonzero entries from existing const ell_matrix and const coo_matrix matrices.

Template Parameters
OtherMatrixType1Type of ell_matrix used to construct view
OtherMatrixType2Type of coo_matrix used to construct view
Parameters
ellMatrix containing ELL portion of hyb_format.
cooMatrix containing COO portion of hyb_format.

Definition at line 409 of file hyb_matrix.h.

◆ hyb_matrix_view() [4/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( hyb_matrix< IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a hyb_matrix_view from a existing hyb_matrix.

Parameters
matrixhyb_matrix used to create view.

Definition at line 416 of file hyb_matrix.h.

◆ hyb_matrix_view() [5/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( const hyb_matrix< IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a hyb_matrix_view from a existing const hyb_matrix.

Parameters
matrixhyb_matrix used to create view.

Definition at line 423 of file hyb_matrix.h.

◆ hyb_matrix_view() [6/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a hyb_matrix_view from a existing hyb_matrix_view.

Parameters
matrixhyb_matrix_view used to create view.

Definition at line 430 of file hyb_matrix.h.

◆ hyb_matrix_view() [7/7]

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::hyb_matrix_view ( const hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a hyb_matrix_view from a existing const hyb_matrix_view.

Parameters
matrixhyb_matrix_view used to create view.

Definition at line 437 of file hyb_matrix.h.

Member Function Documentation

◆ resize()

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
void cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::resize ( size_t  num_rows,
size_t  num_cols,
size_t  num_ell_entries,
size_t  num_coo_entries,
size_t  num_entries_per_row,
size_t  alignment = 32 
)

Resize matrix dimensions and underlying storage

Parameters
num_rowsNumber of rows.
num_colsNumber of columns.
num_ell_entriesNumber of nonzero matrix entries in the ELL portion.
num_coo_entriesNumber of nonzero matrix entries in the ELL portion.
num_entries_per_rowMaximum number of nonzeros per row in the ELL portion.
alignmentAmount of padding used to align the ELL data structure (default 32).

Member Data Documentation

◆ coo

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
coo_matrix_type cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::coo

View to the COO portion of the HYB structure.

Definition at line 380 of file hyb_matrix.h.

◆ ell

template<typename MatrixType1 , typename MatrixType2 , typename IndexType = typename MatrixType1::index_type, typename ValueType = typename MatrixType1::value_type, typename MemorySpace = typename cusp::minimum_space<typename MatrixType1::memory_space, typename MatrixType2::memory_space>::type>
ell_matrix_type cusp::hyb_matrix_view< MatrixType1, MatrixType2, IndexType, ValueType, MemorySpace >::ell

View to the ELL portion of the HYB structure.

Definition at line 376 of file hyb_matrix.h.