|
gslmm::matrix< complex< double > > Class Template Reference
[Matrices]
#include <matrix_complex_double.hh>
Inheritance diagram for gslmm::matrix< complex< double > >:
[legend]Collaboration diagram for gslmm::matrix< complex< double > >:
[legend]List of all members.
Detailed Description
template<>
class gslmm::matrix< complex< double > >
Matrix complex<double> specialisation.
|
Public Types |
typedef size_t | size_type |
typedef size_t | iterator |
typedef complex< double > | value_type |
typedef double | element_type |
typedef gsl_matrix_complex | data_type |
typedef gsl_matrix_complex_view | view_type |
typedef vector< value_type > | vector_type |
typedef type_trait< value_type > | trait_type |
typedef trait_type::reference_type | reference_type |
Public Member Functions |
| matrix (const _matrix_mult< complex< double > > &p) |
| matrix (const _matrix_manip_mult< complex< double > > &p) |
| matrix (size_t rows, size_t columns, bool zero=true) |
| matrix (const matrix< value_type > &m, bool trans=false, bool conj=false) |
| matrix (const matrix< value_type > &m, iterator row_offset, iterator column_offset, size_type rows, size_type columns, size_type tda=0) |
| matrix (element_type *array, size_type rows, size_type columns, size_type tda=0) |
| matrix (const vector_type &v, size_type rows, size_type columns, size_type tda=0) |
virtual | ~matrix () |
|
void | swap (const matrix< value_type > &m) |
void | swap_rows (iterator i, iterator j) |
void | swap_columns (iterator i, iterator j) |
void | swap_row_column (iterator i, iterator j) |
|
size_type | row_size () const |
size_type | column_size () const |
bool | is_owner () const |
bool | is_null () const |
size_type | tda () const |
|
void | zero () |
void | set (value_type x) |
void | identity () |
void | transpose () |
void | conjugate () |
|
const reference_type | operator() (iterator row, iterator column) const |
reference_type | operator() (iterator row, iterator column) |
vector_type | operator[] (iterator r) |
const vector_type | operator[] (iterator r) const |
value_type * | element (iterator row, iterator column) |
const value_type * | element (iterator row, iterator column) const |
|
matrix< complex< double > > | operator() (iterator row, iterator column, size_type rows, size_type columns) const |
vector_type | row (iterator r) |
const vector_type | row (iterator r) const |
vector_type | column (iterator c) |
const vector_type | column (iterator c) const |
vector_type | diagonal (int d) |
const vector_type | diagonal (int d) const |
vector_type | sub_diagonal (int s) |
const vector_type | sub_diagonal (int s) const |
vector_type | super_diagonal (int s) |
const vector_type | super_diagonal (int s) const |
|
matrix< value_type > & | operator= (const matrix< value_type > &m) |
matrix< value_type > & | operator= (const _matrix_mult< value_type > &m) |
matrix< value_type > & | operator= (const _matrix_manip_mult< value_type > &m) |
matrix< value_type > & | operator+= (const matrix< value_type > &o) |
matrix< value_type > & | operator-= (const matrix< value_type > &o) |
matrix< value_type > & | operator *= (const matrix< value_type > &o) |
matrix< value_type > & | operator/= (const matrix< value_type > &o) |
matrix< value_type > & | operator+= (const value_type &o) |
matrix< value_type > & | operator-= (const value_type &o) |
matrix< value_type > & | operator *= (const value_type &o) |
matrix< value_type > & | operator/= (const value_type &o) |
Public Attributes |
data_type * | _matrix |
Protected Member Functions |
void | from_view (view_type &view) |
| matrix () |
Member Typedef Documentation
|
Iterator (or indexer) type.
|
|
Type of traits for elements.
|
Constructor & Destructor Documentation
|
Constructor from a product.
- Parameters:
-
|
|
Constructor from a product.
- Parameters:
-
|
gslmm::matrix< complex< double > >::matrix |
( |
size_t |
rows, |
|
|
size_t |
columns, |
|
|
bool |
zero = true |
|
) |
[inline] |
|
|
Constructor.
- Parameters:
-
| rows | Number of rows in matrix. |
| columns | Number of columns in matrix. |
| zero | If true initialise to zero (null) matrix. |
|
|
Copy constructor.
- Parameters:
-
| m | The matrix to copy. |
| trans | If true, the transpose of m is copyied to this object. |
| conj | If true, also conjugate the matrix. |
|
|
View constructor.
- Parameters:
-
| m | Matrix to create view from, |
| row_offset | Offset in row direction, |
| column_offset | Offset in column direction, |
| rows | Rows in view |
| columns | Columns in view. |
| tda | If positive, the physical number of columns in memory. |
|
|
View constructor.
- Parameters:
-
| array | Array to create view from, |
| rows | Rows in view |
| columns | Columns in view. |
| tda | If positive, the physical number of columns in memory. |
|
|
View constructor.
- Parameters:
-
| v | Vector to create view from, |
| rows | Rows in view |
| columns | Columns in view. |
| tda | If positive, the physical number of columns in memory. |
|
gslmm::matrix< complex< double > >::~matrix |
( |
|
) |
[inline, virtual] |
|
gslmm::matrix< complex< double > >::matrix |
( |
|
) |
[inline, protected] |
|
Member Function Documentation
|
Get a column (const version).
- Parameters:
-
| c | The column number to get (starts at 0) |
- Returns:
- the c column of the matrix, as a reference only
|
|
Get a column.
- Parameters:
-
| c | The column number to get (starts at 0) |
- Returns:
- the c column of the matrix, as a reference only
|
|
Get the number of columns.
|
void gslmm::matrix< complex< double > >::conjugate |
( |
|
) |
[inline] |
|
|
Conjugate all elements of the matrix.
|
|
Get the diagonal (const version).
- Parameters:
-
| d | The diagonal number. Negative are below diagonal, positive above, and zero is the diagonal itself. |
- Returns:
- the diagonal of the matrix, as a reference only
|
|
Get the diagonal.
- Parameters:
-
| d | The diagonal number. Negative are below diagonal, positive above, and zero is the diagonal itself. |
- Returns:
- the diagonal of the matrix, as a reference only
|
|
Get a pointer to the element at (row, col).
- Parameters:
-
| row | Row number |
| column | Column number |
- Returns:
- pointer to element (i, j)
|
|
Get a pointer to the element at (row, col).
- Parameters:
-
| row | Row number |
| column | Column number |
- Returns:
- pointer to element (i, j)
|
void gslmm::matrix< complex< double > >::from_view |
( |
view_type & |
view |
) |
[inline, protected] |
|
void gslmm::matrix< complex< double > >::identity |
( |
|
) |
[inline] |
|
|
Make an identity matrix.
only the elements are 1, the rest of the elements are zero. |
bool gslmm::matrix< complex< double > >::is_null |
( |
|
) |
const [inline] |
|
|
Whether this is the null matrix.
|
bool gslmm::matrix< complex< double > >::is_owner |
( |
|
) |
const [inline] |
|
|
Whether this is the owner of the data.
|
|
Multiply all elements by a number.
- Parameters:
-
| o | The number to multiply to this |
- Returns:
- this matrix, where
|
|
Multiply by a matrix, element by element.
- Parameters:
-
| o | The matrix to multiply to this |
- Returns:
- this matrix, where
|
|
Get a sub-matrix of this matrix.
- Parameters:
-
| row | Row in this matrix to start at |
| column | Column in this matrix to start at |
| rows | Number of rows in sub-matrix |
| columns | Number of columns in sub-martix. |
- Returns:
- a new matrix object that does not own the data.
|
|
Member accessor.
- Parameters:
-
| row | The row number |
| column | The column number |
- Returns:
- the -th element.
|
|
Member accessor.
- Parameters:
-
| row | The row number |
| column | The column number |
- Returns:
- the -th element.
|
|
Add a number to all elements.
- Parameters:
-
| o | The number to add to this |
- Returns:
- this matrix, where
|
|
Add a matrix, element by element.
- Parameters:
-
| o | The matrix to add to this |
- Returns:
- this matrix, where
|
|
Subtract a number from all elements.
- Parameters:
-
| o | The number to subtract from this |
- Returns:
- this matrix, where
|
|
Subtract a matrix, element by element.
- Parameters:
-
| o | The matrix to subtract from this |
- Returns:
- this matrix, where
|
|
Divide all elements by a number.
- Parameters:
-
| o | The number to divide into this |
- Returns:
- this matrix, where
|
|
Divide by a matrix, element by element.
- Parameters:
-
| o | The matrix to divide into this |
- Returns:
- this matrix, where
|
|
Get a row (const version).
- Parameters:
-
| r | The row number to get (starts at 0) |
- Returns:
- the r row of the matrix, as a reference only
|
|
Get a row.
- Parameters:
-
| r | The row number to get (starts at 0) |
- Returns:
- the r row of the matrix, as a reference only
|
|
Get a row (const version).
- Parameters:
-
| r | The row number to get (starts at 0) |
- Returns:
- the r row of the matrix, as a reference only
|
|
Get a row.
- Parameters:
-
| r | The row number to get (starts at 0) |
- Returns:
- the r row of the matrix, as a reference only
|
|
Set all elements to one number.
- Parameters:
-
| x | the value to set all elements to. |
|
|
Get a sub-diagonal (const version).
- Parameters:
-
| s | The sub-diagonal number to get (0 is the diagonal) |
- Returns:
- the s sub-diagonal of the matrix, as a reference only
|
|
Get a sub-diagonal.
- Parameters:
-
| s | The sub-diagonal number to get (0 is diagonal) |
- Returns:
- the s sub-diagonal of the matrix, as a reference only
|
|
Get a super-diagonal (const version).
- Parameters:
-
| s | The super-diagonal number to get (0 is the diagonal) |
- Returns:
- the s super-diagonal of the matrix, as a reference only
|
|
Get a super-diagonal.
- Parameters:
-
| s | The super-diagonal number to get (0 is diagonal) |
- Returns:
- the s super-diagonal of the matrix, as a reference only
|
|
Swap row i for column j.
Matrix must be square. |
|
Get the physical number of columns in memory.
|
void gslmm::matrix< complex< double > >::transpose |
( |
|
) |
[inline] |
|
|
Make this into the transpose of it self.
This member function only works for square matricies. |
void gslmm::matrix< complex< double > >::zero |
( |
|
) |
[inline] |
|
|
Reset all elements to zero.
|
Member Data Documentation
The documentation for this class was generated from the following file:
|