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

#include <dia_matrix.h>

Inheritance diagram for cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >:

Public Methods

 dia_matrix_view (void)
 
template<typename OtherArrayType1 , typename OtherArrayType2 >
 dia_matrix_view (size_t num_rows, size_t num_cols, size_t num_entries, OtherArrayType1 &diagonal_offsets, OtherArrayType2 &values)
 
template<typename OtherArrayType1 , typename OtherArrayType2 >
 dia_matrix_view (size_t num_rows, size_t num_cols, size_t num_entries, const OtherArrayType1 &diagonal_offsets, const OtherArrayType2 &values)
 
 dia_matrix_view (dia_matrix< IndexType, ValueType, MemorySpace > &matrix)
 
 dia_matrix_view (const dia_matrix< IndexType, ValueType, MemorySpace > &matrix)
 
 dia_matrix_view (dia_matrix_view &matrix)
 
 dia_matrix_view (const dia_matrix_view &matrix)
 
void resize (const size_t num_rows, const size_t num_cols, const size_t num_entries, const size_t num_diagonals)
 
void resize (const size_t num_rows, const size_t num_cols, const size_t num_entries, const size_t num_diagonals, const size_t alignment)
 

Public Members

diagonal_offsets_array_type diagonal_offsets
 
values_array_type values
 

Detailed description

template<typename ArrayType1, typename ArrayType2, typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
class cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >

View of a dia_matrix.

Template Parameters
ArrayType1Type of diagonal_offsets
ArrayType2Type of values array view
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 dia_matrix_view is a sparse matrix view of a matrix in DIA format constructed from existing data or iterators. All entries in the dia_matrix are sorted according to row indices and internally within each row sorted by column indices.
Note
The diagonal offsets should not contain duplicate entries.
Example
The following code snippet demonstrates how to create a 4-by-3 dia_matrix_view on the host with 3 diagonals and 6 nonzeros.
// include dia_matrix header file
#include <cusp/dia_matrix.h>
#include <cusp/print.h>
int main()
{
typedef cusp::array1d<int,cusp::host_memory> IndexArray;
typedef cusp::array2d<float,cusp::host_memory,cusp::column_major> ValueArray;
typedef typename IndexArray::view IndexArrayView;
typedef typename ValueArray::view ValueArrayView;
// initialize rows, columns, and values
IndexArray diagonal_offsets(3);
ValueArray values(4,3);
// initialize diagonal offsets
diagonal_offsets[0] = -2;
diagonal_offsets[1] = 0;
diagonal_offsets[2] = 1;
// initialize diagonal values
// first diagonal
values(0,2) = 0; // outside matrix
values(1,2) = 0; // outside matrix
values(2,0) = 40;
values(3,0) = 60;
// second diagonal
values(0,1) = 10;
values(1,1) = 0;
values(2,1) = 50;
values(3,1) = 50; // outside matrix
// third diagonal
values(0,2) = 20;
values(1,2) = 30;
values(2,2) = 0; // outside matrix
values(3,2) = 0; // outside matrix
// allocate storage for (4,3) matrix with 6 nonzeros
cusp::dia_matrix_view<IndexArrayView,ValueArrayView> A(
4,3,6,
cusp::make_array1d_view(diagonal_offsets),
cusp::make_array2d_view(values));
// A now represents the following matrix
// [10 20 0]
// [ 0 0 30]
// [40 0 50]
// [ 0 60 0]
// print the constructed coo_matrix
cusp::print(A);
// change first entry in values array
values(0,1) = -1;
// print the updated matrix view
cusp::print(A);
}
cusp::array1d
The array1d class is a 1D vector container that may contain elements stored in "host" or "device" mem...
Definition array1d.h:99
cusp::array2d
The array2d class is a 2D vector container that may contain elements stored in "host" or "device" mem...
Definition array2d.h:94
cusp::dia_matrix_view
View of a dia_matrix.
Definition dia_matrix.h:328
cusp::dia_matrix_view::values
values_array_type values
Definition dia_matrix.h:360
cusp::dia_matrix_view::diagonal_offsets
diagonal_offsets_array_type diagonal_offsets
Definition dia_matrix.h:355
dia_matrix.h
Diagonal matrix format.
cusp::make_array1d_view
array1d_view< Iterator > make_array1d_view(Iterator first, Iterator last)
Definition array1d.h:695
cusp::make_array2d_view
array2d_view< typename cusp::array1d_view< Iterator >, Orientation > make_array2d_view(size_t num_rows, size_t num_cols, size_t pitch, const cusp::array1d_view< Iterator > &values, Orientation)
Definition array2d.h:479
cusp::print
void print(const Printable &p)
print a textual representation of an object
print.h
Print textual representation of an object.

Definition at line 327 of file dia_matrix.h.

Constructor & Destructor Documentation

◆ dia_matrix_view() [1/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( void  )
inline

Construct an empty dia_matrix_view.

Definition at line 365 of file dia_matrix.h.

◆ dia_matrix_view() [2/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
template<typename OtherArrayType1 , typename OtherArrayType2 >
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( size_t  num_rows,
size_t  num_cols,
size_t  num_entries,
OtherArrayType1 &  diagonal_offsets,
OtherArrayType2 &  values 
)
inline

Construct a dia_matrix_view with a specific shape and number of nonzero entries from existing arrays denoting the diagonal offsets and values.

Parameters
num_rowsNumber of rows.
num_colsNumber of columns.
num_entriesNumber of nonzero matrix entries.
diagonal_offsetsArray containing the diagonal offsets.
valuesArray containing the values.

Definition at line 377 of file dia_matrix.h.

◆ dia_matrix_view() [3/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
template<typename OtherArrayType1 , typename OtherArrayType2 >
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( size_t  num_rows,
size_t  num_cols,
size_t  num_entries,
const OtherArrayType1 &  diagonal_offsets,
const OtherArrayType2 &  values 
)
inline

Construct a dia_matrix_view with a specific shape and number of nonzero entries from existing const arrays denoting the diagonal offsets and values.

Parameters
num_rowsNumber of rows.
num_colsNumber of columns.
num_entriesNumber of nonzero matrix entries.
diagonal_offsetsArray containing the diagonal offsets.
valuesArray containing the values.

Definition at line 393 of file dia_matrix.h.

◆ dia_matrix_view() [4/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( dia_matrix< IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a dia_matrix_view from a existing dia_matrix.

Parameters
matrixdia_matrix used to create view.

Definition at line 403 of file dia_matrix.h.

◆ dia_matrix_view() [5/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( const dia_matrix< IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a dia_matrix_view from a existing const dia_matrix.

Parameters
matrixdia_matrix used to create view.

Definition at line 412 of file dia_matrix.h.

◆ dia_matrix_view() [6/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a dia_matrix_view from a existing dia_matrix_view.

Parameters
matrixdia_matrix_view used to create view.

Definition at line 421 of file dia_matrix.h.

◆ dia_matrix_view() [7/7]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::dia_matrix_view ( const dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace > &  matrix)
inline

Construct a dia_matrix_view from a existing const dia_matrix_view.

Parameters
matrixdia_matrix_view used to create view.

Definition at line 430 of file dia_matrix.h.

Member Function Documentation

◆ resize() [1/2]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
void cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::resize ( const size_t  num_rows,
const size_t  num_cols,
const size_t  num_entries,
const size_t  num_diagonals 
)

Resize matrix dimensions and underlying storage

Parameters
num_rowsNumber of rows.
num_colsNumber of columns.
num_entriesNumber of nonzero matrix entries.
num_diagonalsNumber of occupied diagonals.

◆ resize() [2/2]

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
void cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::resize ( const size_t  num_rows,
const size_t  num_cols,
const size_t  num_entries,
const size_t  num_diagonals,
const size_t  alignment 
)

Resize matrix dimensions and underlying storage

Parameters
num_rowsNumber of rows.
num_colsNumber of columns.
num_entriesNumber of nonzero matrix entries.
num_diagonalsNumber of occupied diagonals.
alignmentAmount of padding used to align the data structure (default 32).

Member Data Documentation

◆ diagonal_offsets

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
diagonal_offsets_array_type cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::diagonal_offsets

View of the diagonal_offsets of the DIA data structure.

Definition at line 355 of file dia_matrix.h.

◆ values

template<typename ArrayType1 , typename ArrayType2 , typename IndexType = typename ArrayType1::value_type, typename ValueType = typename ArrayType2::value_type, typename MemorySpace = typename cusp::minimum_space<typename ArrayType1::memory_space, typename ArrayType2::memory_space>::type>
values_array_type cusp::dia_matrix_view< ArrayType1, ArrayType2, IndexType, ValueType, MemorySpace >::values

View for the nonzero entries of the DIA data structure.

Definition at line 360 of file dia_matrix.h.