A Hankel matrix class.
More...
#include <forwards.h>
template<class SCALARTYPE, unsigned int ALIGNMENT = 1>
class viennacl::hankel_matrix< SCALARTYPE, ALIGNMENT >
A Hankel matrix class.
- Template Parameters
-
SCALARTYPE | The underlying scalar type (either float or double) |
ALIGNMENT | The internal memory size is given by (size()/ALIGNMENT + 1) * ALIGNMENT. ALIGNMENT must be a power of two. Best values or usually 4, 8 or 16, higher values are usually a waste of memory. |
The default constructor. Does not allocate any memory.
Creates the matrix with the given size.
- Parameters
-
rows | Number of rows of the matrix |
cols | Number of columns of the matrix |
Returns the OpenCL handle.
- Returns
- OpenCL handle
Returns the internal size of matrix representtion. Usually required for launching OpenCL kernels only.
- Returns
- Internal size of matrix representation
entry_proxy<SCALARTYPE> operator() |
( |
unsigned int |
row_index, |
|
|
unsigned int |
col_index |
|
) |
| |
|
inline |
Read-write access to a element of the matrix.
- Parameters
-
row_index | Row index of accessed element |
col_index | Column index of accessed element |
- Returns
- Proxy for matrix entry
+= operation for Hankel matrices
- Parameters
-
that | Matrix which will be added |
- Returns
- Result of addition
void resize |
( |
vcl_size_t |
sz, |
|
|
bool |
preserve = true |
|
) |
| |
|
inline |
Resizes the matrix. Existing entries can be preserved.
- Parameters
-
sz | New size of matrix |
preserve | If true, existing values are preserved. |
Returns the number of rows of the matrix.
Returns the number of columns of the matrix.
The documentation for this class was generated from the following files: