ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
gsl::matrix_complex Class Reference

This class handles matrix_complex objects as shared handles. More...

#include <matrix_complex.hpp>

Collaboration diagram for gsl::matrix_complex:
Collaboration graph

Classes

class  const_iterator_t
 A class template for the const iterators. More...
 
class  iterator_base
 We create a suitable class for iterator types here. More...
 
class  iterator_t
 A class template for the two non-const iterators. More...
 
struct  vector_complex_ptr
 This is a pointer-like type for iterator return values. More...
 

Public Types

typedef const_iterator_t< false > const_iterator
 The const_iterator type. More...
 
typedef iterator_t< false > iterator
 The iterator type. More...
 
typedef const_iterator_t< true > const_reverse_iterator
 The const_reverse_t type. More...
 
typedef iterator_t< true > reverse_iterator
 The reverse_iterator type. More...
 
typedef size_t size_type
 A container must have a size_type. More...
 

Public Member Functions

 matrix_complex ()
 The default constructor is only really useful for assigning to. More...
 
 matrix_complex (size_t const n1, size_t const n2)
 The default constructor creates a new matrix_complex with n1 rows and n2 columns. More...
 
 matrix_complex (gsl_matrix_complex *v)
 Could construct from a gsl_matrix_complex. More...
 
 matrix_complex (std::initializer_list< std::initializer_list< std::complex< double > > > initializer_list)
 Could construct from a std::initializer_list in C++11. More...
 
 matrix_complex (matrix_complex const &v)
 The copy constructor. More...
 
matrix_complex & operator= (matrix_complex const &v)
 The assignment operator. More...
 
matrix_complex clone () const
 The clone function. More...
 
 ~matrix_complex ()
 The destructor only deletes the pointers if count reaches zero. More...
 
void reset ()
 Stop sharing ownership of the shared pointer. More...
 
 matrix_complex (matrix_complex &&v)
 Move constructor. More...
 
matrix_complex & operator= (matrix_complex &&v)
 Move operator. More...
 
iterator begin ()
 Get iterator pointing to first vector_complex element. More...
 
const_iterator begin () const
 Get iterator pointing to first vector_complex element. More...
 
iterator end ()
 Get iterator pointing beyond last vector_complex element. More...
 
const_iterator end () const
 Get iterator pointing beyond last vector_complex element. More...
 
reverse_iterator rbegin ()
 Get iterator pointing to first vector_complex element. More...
 
const_reverse_iterator rbegin () const
 Get iterator pointing to first vector_complex element. More...
 
reverse_iterator rend ()
 Get iterator pointing beyond last vector_complex element. More...
 
const_reverse_iterator rend () const
 Get iterator pointing beyond last vector_complex element. More...
 
size_t size1 () const
 The number of rows of the matrix_complex. More...
 
size_t size2 () const
 The number of columns of the matrix_complex. More...
 
void swap (matrix_complex &m)
 Swap two matrix_complex objects. More...
 
void tricpy (CBLAS_UPLO_t Uplo, CBLAS_DIAG_t Diag, matrix_complex const &src)
 Copy the upper or lower triangular part of matrix src to this. More...
 
void transpose_tricpy (CBLAS_UPLO_t Uplo, CBLAS_DIAG_t Diag, matrix_complex const &src)
 Copy the upper or lower triangular part of matrix src to this. More...
 
matrix_complex submatrix (size_t const i, size_t const j, size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_submatrix(). More...
 
vector_complex row (size_t const i)
 C++ version of gsl_matrix_complex_row(). More...
 
vector_complex column (size_t const j)
 C++ version of gsl_matrix_complex_column(). More...
 
vector_complex diagonal ()
 C++ version of gsl_matrix_complex_diagonal(). More...
 
vector_complex subdiagonal (size_t const k)
 C++ version of gsl_matrix_complex_subdiagonal(). More...
 
vector_complex superdiagonal (size_t const k)
 C++ version of gsl_matrix_complex_superdiagonal(). More...
 
vector_complex subrow (size_t const i, size_t const offset, size_t const n)
 C++ version of gsl_matrix_complex_subrow(). More...
 
vector_complex subcolumn (size_t const j, size_t const offset, size_t const n)
 C++ version of gsl_matrix_complex_subcolumn(). More...
 
matrix_complex const const_submatrix (size_t const i, size_t const j, size_t const n1, size_t const n2) const
 C++ version of gsl_matrix_complex_const_submatrix(). More...
 
vector_complex const const_row (size_t const i) const
 C++ version of gsl_matrix_complex_const_row(). More...
 
vector_complex const const_column (size_t const j) const
 C++ version of gsl_matrix_complex_const_column(). More...
 
vector_complex const const_diagonal () const
 C++ version of gsl_matrix_complex_const_diagonal(). More...
 
vector_complex const const_subdiagonal (size_t const k) const
 C++ version of gsl_matrix_complex_const_subdiagonal(). More...
 
vector_complex const const_superdiagonal (size_t const k) const
 C++ version of gsl_matrix_complex_const_superdiagonal(). More...
 
vector_complex const const_subrow (size_t const i, size_t const offset, size_t const n) const
 C++ version of gsl_matrix_complex_const_subrow(). More...
 
vector_complex const const_subcolumn (size_t const j, size_t const offset, size_t const n) const
 C++ version of gsl_matrix_complex_const_subcolumn(). More...
 
matrix_complex const submatrix (size_t const i, size_t const j, size_t const n1, size_t const n2) const
 Another C++ version of gsl_matrix_complex_const_submatrix(). More...
 
vector_complex const row (size_t const i) const
 Another C++ version of gsl_matrix_complex_const_row(). More...
 
vector_complex const column (size_t const j) const
 Another C++ version of gsl_matrix_complex_const_column(). More...
 
vector_complex const diagonal () const
 Another C++ version of gsl_matrix_complex_const_diagonal(). More...
 
vector_complex const subdiagonal (size_t const k) const
 Another C++ version of gsl_matrix_complex_const_subdiagonal(). More...
 
vector_complex const superdiagonal (size_t const k) const
 Another C++ version of gsl_matrix_complex_const_superdiagonal(). More...
 
vector_complex const subrow (size_t const i, size_t const offset, size_t const n) const
 Another C++ version of gsl_matrix_complex_const_subrow(). More...
 
vector_complex const subcolumn (size_t const j, size_t const offset, size_t const n) const
 Another C++ version of gsl_matrix_complex_const_subcolumn(). More...
 
gsl_matrix_complex * get ()
 Get the gsl_matrix_complex. More...
 
gsl_matrix_complex const * get () const
 Get the gsl_matrix_complex. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_matrix_complex. More...
 
size_t use_count () const
 Find how many matrix_complex objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 
void set_zero ()
 C++ version of gsl_matrix_complex_set_zero(). More...
 
void set_all (complex x)
 C++ version of gsl_matrix_complex_set_all(). More...
 
int memcpy (matrix_complex const &src)
 C++ version of gsl_matrix_complex_memcpy(). More...
 
int add (matrix_complex const &b)
 C++ version of gsl_matrix_complex_add(). More...
 
int sub (matrix_complex const &b)
 C++ version of gsl_matrix_complex_sub(). More...
 
int scale (complex const x)
 C++ version of gsl_matrix_complex_scale(). More...
 
int add_constant (complex const x)
 C++ version of gsl_matrix_complex_add_constant(). More...
 
int isnull () const
 C++ version of gsl_matrix_complex_isnull(). More...
 
int ispos () const
 C++ version of gsl_matrix_complex_ispos(). More...
 
int isneg () const
 C++ version of gsl_matrix_complex_isneg(). More...
 
int isnonneg () const
 C++ version of gsl_matrix_complex_isnonneg(). More...
 
complex get (size_t const i, size_t const j) const
 C++ version of gsl_matrix_complex_get(). More...
 
void set (size_t const i, size_t const j, complex x)
 C++ version of gsl_matrix_complex_set(). More...
 
complex_ptr ptr (size_t const i, size_t const j)
 C++ version of gsl_matrix_complex_ptr(). More...
 
complex_ptr const const_ptr (size_t const i, size_t const j) const
 C++ version of gsl_matrix_complex_const_ptr(). More...
 
int fread (FILE *stream)
 C++ version of gsl_matrix_complex_fread(). More...
 
int fwrite (FILE *stream) const
 C++ version of gsl_matrix_complex_fwrite(). More...
 
int fscanf (FILE *stream)
 C++ version of gsl_matrix_complex_fscanf(). More...
 
int fprintf (FILE *stream, char const *format) const
 C++ version of gsl_matrix_complex_fprintf(). More...
 
 matrix_complex (block_complex &b, size_t const offset, size_t const n1, size_t const n2, size_t const d2)
 C++ version of gsl_matrix_complex_alloc_from_block(). More...
 
 matrix_complex (matrix_complex &m, size_t const k1, size_t const k2, size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_alloc_from_matrix(). More...
 
void set_identity ()
 C++ version of gsl_matrix_complex_set_identity(). More...
 
int swap_rows (size_t const i, size_t const j)
 C++ version of gsl_matrix_complex_swap_rows(). More...
 
int swap_columns (size_t const i, size_t const j)
 C++ version of gsl_matrix_complex_swap_columns(). More...
 
int swap_rowcol (size_t const i, size_t const j)
 C++ version of gsl_matrix_complex_swap_rowcol(). More...
 
int transpose ()
 C++ version of gsl_matrix_complex_transpose(). More...
 
int transpose_memcpy (matrix_complex const &src)
 C++ version of gsl_matrix_complex_transpose_memcpy(). More...
 
int mul_elements (matrix_complex const &b)
 C++ version of gsl_matrix_complex_mul_elements(). More...
 
int div_elements (matrix_complex const &b)
 C++ version of gsl_matrix_complex_div_elements(). More...
 
int conjtrans_memcpy (matrix_complex const &src)
 C++ version of gsl_matrix_complex_conjtrans_memcpy(). More...
 
int scale_rows (vector_complex const &x)
 C++ version of gsl_matrix_complex_scale_rows(). More...
 
int scale_columns (vector_complex const &x)
 C++ version of gsl_matrix_complex_scale_columns(). More...
 
int add_diagonal (complex const x)
 C++ version of gsl_matrix_complex_add_diagonal(). More...
 
int get_row (vector_complex &v, size_t const i) const
 C++ version of gsl_matrix_complex_get_row(). More...
 
int get_col (vector_complex &v, size_t const j) const
 C++ version of gsl_matrix_complex_get_col(). More...
 
int set_row (size_t const i, vector_complex const &v)
 C++ version of gsl_matrix_complex_set_row(). More...
 
int set_col (size_t const j, vector_complex const &v)
 C++ version of gsl_matrix_complex_set_col(). More...
 
vector_complex operator[] (size_t const i)
 This function allows us to use a matrix_complex like an array. More...
 
vector_complex const operator[] (size_t const i) const
 This function allows us to use a matrix_complex like an array. More...
 
int permute (permutation &p)
 Permute the columns of this by permutation p. More...
 

Static Public Member Functions

static matrix_complex view_array (double *base, size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_view_array(). More...
 
static matrix_complex view_array_with_tda (double *base, size_t const n1, size_t const n2, size_t const tda)
 C++ version of gsl_matrix_complex_view_array_with_tda(). More...
 
static matrix_complex view_vector (vector_complex &v, size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_view_vector(). More...
 
static matrix_complex view_vector_with_tda (vector_complex &v, size_t const n1, size_t const n2, size_t const tda)
 C++ version of gsl_matrix_complex_view_vector_with_tda(). More...
 
static matrix_complex const const_view_array (double const *base, size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_const_view_array(). More...
 
static matrix_complex const const_view_array_with_tda (double const *base, size_t const n1, size_t const n2, size_t const tda)
 C++ version of gsl_matrix_complex_const_view_array_with_tda(). More...
 
static matrix_complex const const_view_vector (vector_complex const &v, size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_const_view_vector(). More...
 
static matrix_complex const const_view_vector_with_tda (vector_complex const &v, size_t const n1, size_t const n2, size_t const tda)
 C++ version of gsl_matrix_complex_const_view_vector_with_tda(). More...
 
static matrix_complex const view_array (double const *base, size_t const n1, size_t const n2)
 Another C++ version of gsl_matrix_complex_const_view_array(). More...
 
static matrix_complex const view_array_with_tda (double const *base, size_t const n1, size_t const n2, size_t const tda)
 Another C++ version of gsl_matrix_complex_const_view_array_with_tda(). More...
 
static matrix_complex const view_vector (vector_complex const &v, size_t const n1, size_t const n2)
 Another C++ version of gsl_matrix_complex_const_view_vector(). More...
 
static matrix_complex const view_vector_with_tda (vector_complex const &v, size_t const n1, size_t const n2, size_t const tda)
 Another C++ version of gsl_matrix_complex_const_view_vector_with_tda(). More...
 
static matrix_complex calloc (size_t const n1, size_t const n2)
 C++ version of gsl_matrix_complex_calloc(). More...
 

Private Attributes

gsl_matrix_complex * ccgsl_pointer
 The shared pointer. More...
 
size_t * count
 The shared reference count. More...
 

Detailed Description

This class handles matrix_complex objects as shared handles.

It models a random access container so that STL functions work with matrix_complex.

Note that matrix_views are implemented as matrix_complex objects here.

Note that in C++11 it is possible to iterate over the rows of a matrix using

for( auto row : matrix ){ ... }
gsl::matrix_complex::row
vector_complex row(size_t const i)
C++ version of gsl_matrix_complex_row().
Definition: matrix_complex.hpp:724
gsl::matrix
This class handles matrix objects as shared handles.
Definition: matrix.hpp:72

Otherwise,

for( matrix_complex::iterator i = matrix.begin(); i != matrix.end(); ++i ){
vector_complex row = *i;
...
}
gsl::matrix_complex::iterator_t
A class template for the two non-const iterators.
Definition: matrix_complex.hpp:385
gsl::matrix::end
iterator end()
Get iterator pointing beyond last vector element.
Definition: matrix.hpp:663
gsl::matrix::begin
iterator begin()
Get iterator pointing to first vector element.
Definition: matrix.hpp:648
gsl::vector_complex
This class handles vector_complex objects as shared handles.
Definition: vector_complex.hpp:46

will achieve the same effect. But if the element pointed to by i is used more than once, do not use

i-> ...

because each call of operator->() creates a new and different vector_complex.

Definition at line 62 of file matrix_complex.hpp.

Member Typedef Documentation

◆ const_iterator

typedef const_iterator_t<false> gsl::matrix_complex::const_iterator

The const_iterator type.

Definition at line 585 of file matrix_complex.hpp.

◆ const_reverse_iterator

typedef const_iterator_t<true> gsl::matrix_complex::const_reverse_iterator

The const_reverse_t type.

Definition at line 593 of file matrix_complex.hpp.

◆ iterator

typedef iterator_t<false> gsl::matrix_complex::iterator

The iterator type.

Definition at line 589 of file matrix_complex.hpp.

◆ reverse_iterator

typedef iterator_t<true> gsl::matrix_complex::reverse_iterator

The reverse_iterator type.

Definition at line 597 of file matrix_complex.hpp.

◆ size_type

typedef size_t gsl::matrix_complex::size_type

A container must have a size_type.

Definition at line 601 of file matrix_complex.hpp.

Constructor & Destructor Documentation

◆ matrix_complex() [1/8]

gsl::matrix_complex::matrix_complex ( )
inline

The default constructor is only really useful for assigning to.

Definition at line 67 of file matrix_complex.hpp.

References ccgsl_pointer, and count.

Referenced by calloc(), const_submatrix(), const_view_array(), const_view_array_with_tda(), const_view_vector(), const_view_vector_with_tda(), operator=(), reset(), submatrix(), view_array(), view_array_with_tda(), view_vector(), and view_vector_with_tda().

◆ matrix_complex() [2/8]

gsl::matrix_complex::matrix_complex ( size_t const  n1,
size_t const  n2 
)
inlineexplicit

The default constructor creates a new matrix_complex with n1 rows and n2 columns.

Parameters
n1The number of rows in the matrix_complex
n2The number of columns in the matrix_complex

Definition at line 78 of file matrix_complex.hpp.

References ccgsl_pointer, and count.

◆ matrix_complex() [3/8]

gsl::matrix_complex::matrix_complex ( gsl_matrix_complex *  v)
inlineexplicit

Could construct from a gsl_matrix_complex.

This is not usually a good idea. In this case you should not use gsl_matrix_complex_free() to deallocate the memory.

Parameters
vThe matrix_complex

Definition at line 96 of file matrix_complex.hpp.

References ccgsl_pointer, and count.

◆ matrix_complex() [4/8]

gsl::matrix_complex::matrix_complex ( std::initializer_list< std::initializer_list< std::complex< double > > >  initializer_list)
inline

Could construct from a std::initializer_list in C++11.

Parameters
initializer_listThe initializer_list.

Definition at line 107 of file matrix_complex.hpp.

References ccgsl_pointer, count, gsl::exception::GSL_EBADLEN, row(), and set().

◆ matrix_complex() [5/8]

gsl::matrix_complex::matrix_complex ( matrix_complex const &  v)
inline

The copy constructor.

This shares the matrix_complex. Use clone() if you want a full copy.

Parameters
vThe matrix_complex to copy.

Definition at line 140 of file matrix_complex.hpp.

References count.

◆ ~matrix_complex()

gsl::matrix_complex::~matrix_complex ( )
inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 178 of file matrix_complex.hpp.

References ccgsl_pointer, and count.

◆ matrix_complex() [6/8]

gsl::matrix_complex::matrix_complex ( matrix_complex &&  v)
inline

Move constructor.

Parameters
vThe matrix_complex to move.

Definition at line 196 of file matrix_complex.hpp.

References count.

◆ matrix_complex() [7/8]

gsl::matrix_complex::matrix_complex ( block_complex &  b,
size_t const  offset,
size_t const  n1,
size_t const  n2,
size_t const  d2 
)
inline

C++ version of gsl_matrix_complex_alloc_from_block().

Parameters
bThe block_complex
offsetThe offset within the block_complex
n1The number of rows in the matrix_complex
n2The number of columns in the matrix_complex
d2undocumented

Definition at line 1300 of file matrix_complex.hpp.

References gsl::sf::mathieu::b(), ccgsl_pointer, and count.

◆ matrix_complex() [8/8]

gsl::matrix_complex::matrix_complex ( matrix_complex &  m,
size_t const  k1,
size_t const  k2,
size_t const  n1,
size_t const  n2 
)
inline

C++ version of gsl_matrix_complex_alloc_from_matrix().

Parameters
mThe matrix_complex
k1the row of m to take as row zero
k2the column of m to take as column zero
n1The number of rows in the matrix_complex
n2The number of columns in the matrix_complex

Definition at line 1318 of file matrix_complex.hpp.

References ccgsl_pointer, count, and get().

Member Function Documentation

◆ add()

int gsl::matrix_complex::add ( matrix_complex const &  b)
inline

C++ version of gsl_matrix_complex_add().

Parameters
bmatrix_complex to add to this
Returns
error code on failure

Definition at line 1189 of file matrix_complex.hpp.

References gsl::sf::mathieu::b(), and get().

◆ add_constant()

int gsl::matrix_complex::add_constant ( complex const  x)
inline

C++ version of gsl_matrix_complex_add_constant().

Parameters
xconstant to add to each element of this
Returns
error code on failure

Definition at line 1207 of file matrix_complex.hpp.

References get().

◆ add_diagonal()

int gsl::matrix_complex::add_diagonal ( complex const  x)
inline

C++ version of gsl_matrix_complex_add_diagonal().

Parameters
xA constant
Returns
error code on failure

Definition at line 1410 of file matrix_complex.hpp.

References get().

◆ begin() [1/2]

iterator gsl::matrix_complex::begin ( )
inline

Get iterator pointing to first vector_complex element.

Returns
iterator pointing to first vector_complex element

Definition at line 607 of file matrix_complex.hpp.

◆ begin() [2/2]

const_iterator gsl::matrix_complex::begin ( ) const
inline

Get iterator pointing to first vector_complex element.

Returns
iterator pointing to first vector_complex element

Definition at line 614 of file matrix_complex.hpp.

◆ calloc()

static matrix_complex gsl::matrix_complex::calloc ( size_t const  n1,
size_t const  n2 
)
inlinestatic

C++ version of gsl_matrix_complex_calloc().

This constructs a matrix_complex object with entries initialised to zero.

Parameters
n1The number of rows in the matrix_complex
n2The number of columns in the matrix_complex
Returns
A matrix_complex initialised to zero

Definition at line 1168 of file matrix_complex.hpp.

References matrix_complex().

◆ clone()

matrix_complex gsl::matrix_complex::clone ( ) const
inline

The clone function.

Use this if you want a copy of the block_complex that does not share the underlying data.

Returns
a new copy of this.

Definition at line 167 of file matrix_complex.hpp.

References get(), size1(), and size2().

◆ column() [1/2]

vector_complex gsl::matrix_complex::column ( size_t const  j)
inline

C++ version of gsl_matrix_complex_column().

Parameters
jA column index
Returns
A column as a vector_complex

Definition at line 734 of file matrix_complex.hpp.

References get().

◆ column() [2/2]

vector_complex const gsl::matrix_complex::column ( size_t const  j) const
inline

Another C++ version of gsl_matrix_complex_const_column().

Parameters
jA column index
Returns
A column as a vector_complex

Definition at line 1009 of file matrix_complex.hpp.

References get().

◆ conjtrans_memcpy()

int gsl::matrix_complex::conjtrans_memcpy ( matrix_complex const &  src)
inline

C++ version of gsl_matrix_complex_conjtrans_memcpy().

Parameters
srcSource matrix
Returns
error code on failure

Definition at line 1389 of file matrix_complex.hpp.

References get().

◆ const_column()

vector_complex const gsl::matrix_complex::const_column ( size_t const  j) const
inline

C++ version of gsl_matrix_complex_const_column().

Parameters
jA column index
Returns
A column as a vector_complex

Definition at line 871 of file matrix_complex.hpp.

References get().

◆ const_diagonal()

vector_complex const gsl::matrix_complex::const_diagonal ( ) const
inline

C++ version of gsl_matrix_complex_const_diagonal().

Returns
The principal diagonal as a vector_complex

Definition at line 880 of file matrix_complex.hpp.

References get().

◆ const_ptr()

complex_ptr const gsl::matrix_complex::const_ptr ( size_t const  i,
size_t const  j 
) const
inline

C++ version of gsl_matrix_complex_const_ptr().

Parameters
iindex of row
jindex of column
Returns
pointer to element

Definition at line 1260 of file matrix_complex.hpp.

References CCGSL_MTY, ccgsl_pointer, get(), and gsl::exception::GSL_EINVAL.

◆ const_row()

vector_complex const gsl::matrix_complex::const_row ( size_t const  i) const
inline

C++ version of gsl_matrix_complex_const_row().

Parameters
iA row index
Returns
A row as a vector_complex

Definition at line 861 of file matrix_complex.hpp.

References get().

◆ const_subcolumn()

vector_complex const gsl::matrix_complex::const_subcolumn ( size_t const  j,
size_t const  offset,
size_t const  n 
) const
inline

C++ version of gsl_matrix_complex_const_subcolumn().

Parameters
jA column index
offsetA row offset
nThe number of elements
Returns
A subcolumn as a vector_complex

Definition at line 924 of file matrix_complex.hpp.

References get(), and gsl::rstat::n().

◆ const_subdiagonal()

vector_complex const gsl::matrix_complex::const_subdiagonal ( size_t const  k) const
inline

C++ version of gsl_matrix_complex_const_subdiagonal().

Parameters
kAn index
Returns
Subdiagonal k as a vector_complex

Definition at line 890 of file matrix_complex.hpp.

References get().

◆ const_submatrix()

matrix_complex const gsl::matrix_complex::const_submatrix ( size_t const  i,
size_t const  j,
size_t const  n1,
size_t const  n2 
) const
inline

C++ version of gsl_matrix_complex_const_submatrix().

Parameters
iIndex in this of first row of submatrix
jIndex in this of first column of submatrix
n1Number of rows of submatrix
n2Number of columns of submatrix
Returns
The submatrix

Definition at line 851 of file matrix_complex.hpp.

References get(), and matrix_complex().

◆ const_subrow()

vector_complex const gsl::matrix_complex::const_subrow ( size_t const  i,
size_t const  offset,
size_t const  n 
) const
inline

C++ version of gsl_matrix_complex_const_subrow().

Parameters
iA row index
offsetA column offset
nThe number of elements
Returns
A subrow as a vector_complex

Definition at line 912 of file matrix_complex.hpp.

References get(), and gsl::rstat::n().

◆ const_superdiagonal()

vector_complex const gsl::matrix_complex::const_superdiagonal ( size_t const  k) const
inline

C++ version of gsl_matrix_complex_const_superdiagonal().

Parameters
kAn index
Returns
Subdiagonal k as a vector_complex

Definition at line 900 of file matrix_complex.hpp.

References get().

◆ const_view_array()

static matrix_complex const gsl::matrix_complex::const_view_array ( double const *  base,
size_t const  n1,
size_t const  n2 
)
inlinestatic

C++ version of gsl_matrix_complex_const_view_array().

Parameters
baseAn array of type double
n1The number of rows
n2The number of columns
Returns
A matrix_complex

Definition at line 936 of file matrix_complex.hpp.

References matrix_complex().

◆ const_view_array_with_tda()

static matrix_complex const gsl::matrix_complex::const_view_array_with_tda ( double const *  base,
size_t const  n1,
size_t const  n2,
size_t const  tda 
)
inlinestatic

C++ version of gsl_matrix_complex_const_view_array_with_tda().

Parameters
baseAn array of type double
n1The number of rows
n2The number of columns
tdaThe number of columns in memory
Returns
A matrix_complex

Definition at line 950 of file matrix_complex.hpp.

References matrix_complex().

◆ const_view_vector()

static matrix_complex const gsl::matrix_complex::const_view_vector ( vector_complex const &  v,
size_t const  n1,
size_t const  n2 
)
inlinestatic

C++ version of gsl_matrix_complex_const_view_vector().

Parameters
vA vector_complex
n1The number of rows
n2The number of columns
Returns
A matrix_complex

Definition at line 962 of file matrix_complex.hpp.

References gsl::vector_complex::get(), and matrix_complex().

◆ const_view_vector_with_tda()

static matrix_complex const gsl::matrix_complex::const_view_vector_with_tda ( vector_complex const &  v,
size_t const  n1,
size_t const  n2,
size_t const  tda 
)
inlinestatic

C++ version of gsl_matrix_complex_const_view_vector_with_tda().

Parameters
vA vector_complex
n1The number of rows
n2The number of columns
tdaThe number of columns in memory
Returns
A matrix_complex

Definition at line 976 of file matrix_complex.hpp.

References gsl::vector_complex::get(), and matrix_complex().

◆ diagonal() [1/2]

vector_complex gsl::matrix_complex::diagonal ( )
inline

C++ version of gsl_matrix_complex_diagonal().

Returns
The principal diagonal as a vector_complex

Definition at line 744 of file matrix_complex.hpp.

References get().

◆ diagonal() [2/2]

vector_complex const gsl::matrix_complex::diagonal ( ) const
inline

Another C++ version of gsl_matrix_complex_const_diagonal().

Returns
The principal diagonal as a vector_complex

Definition at line 1018 of file matrix_complex.hpp.

References get().

◆ div_elements()

int gsl::matrix_complex::div_elements ( matrix_complex const &  b)
inline

C++ version of gsl_matrix_complex_div_elements().

Divide each element of this by the corrsponding element of b

Parameters
bAnother matrix_complex
Returns
error code on failure

Definition at line 1382 of file matrix_complex.hpp.

References gsl::sf::mathieu::b(), and get().

◆ end() [1/2]

iterator gsl::matrix_complex::end ( )
inline

Get iterator pointing beyond last vector_complex element.

Returns
iterator pointing beyond last vector_complex element

Definition at line 622 of file matrix_complex.hpp.

References ccgsl_pointer, and size1().

◆ end() [2/2]

const_iterator gsl::matrix_complex::end ( ) const
inline

Get iterator pointing beyond last vector_complex element.

Returns
iterator pointing beyond last vector_complex element

Definition at line 630 of file matrix_complex.hpp.

References ccgsl_pointer, and size1().

◆ fprintf()

int gsl::matrix_complex::fprintf ( FILE *  stream,
char const *  format 
) const
inline

C++ version of gsl_matrix_complex_fprintf().

Parameters
streamA C file stream
formatd, e, f or g
Returns
error code on failure

Definition at line 1290 of file matrix_complex.hpp.

References get().

◆ fread()

int gsl::matrix_complex::fread ( FILE *  stream)
inline

C++ version of gsl_matrix_complex_fread().

Parameters
streamA C file stream
Returns
error code on failure

Definition at line 1271 of file matrix_complex.hpp.

References get().

◆ fscanf()

int gsl::matrix_complex::fscanf ( FILE *  stream)
inline

C++ version of gsl_matrix_complex_fscanf().

Parameters
streamA C file stream
Returns
error code on failure

Definition at line 1283 of file matrix_complex.hpp.

References get().

◆ fwrite()

int gsl::matrix_complex::fwrite ( FILE *  stream) const
inline

C++ version of gsl_matrix_complex_fwrite().

Parameters
streamA C file stream
Returns
error code on failure

Definition at line 1277 of file matrix_complex.hpp.

References get().

◆ get() [1/3]

gsl_matrix_complex * gsl::matrix_complex::get ( )
inline

Get the gsl_matrix_complex.

Returns
the gsl_matrix_complex

Definition at line 1134 of file matrix_complex.hpp.

References ccgsl_pointer.

Referenced by add(), add_constant(), add_diagonal(), clone(), column(), gsl::linalg::complex_cholesky_decomp(), gsl::linalg::complex_cholesky_solve(), gsl::linalg::complex_cholesky_svx(), gsl::linalg::complex_householder_hm(), gsl::linalg::complex_householder_left(), gsl::linalg::complex_householder_mh(), gsl::linalg::complex_LU_decomp(), gsl::linalg::complex_LU_det(), gsl::linalg::complex_LU_invert(), gsl::linalg::complex_LU_invx(), gsl::linalg::complex_LU_lndet(), gsl::linalg::complex_LU_refine(), gsl::linalg::complex_LU_sgndet(), gsl::linalg::complex_LU_solve(), gsl::linalg::complex_LU_svx(), gsl::linalg::complex_QR_decomp(), gsl::linalg::complex_QR_decomp_r(), gsl::linalg::complex_QR_lssolve(), gsl::linalg::complex_QR_lssolve_r(), gsl::linalg::complex_QR_QHvec(), gsl::linalg::complex_QR_QHvec_r(), gsl::linalg::complex_QR_Qvec(), gsl::linalg::complex_QR_solve(), gsl::linalg::complex_QR_solve_r(), gsl::linalg::complex_QR_svx(), gsl::linalg::complex_QR_unpack(), gsl::linalg::complex_QR_unpack_r(), gsl::linalg::complex_tri_invert(), gsl::linalg::complex_tri_LHL(), gsl::linalg::complex_tri_UL(), conjtrans_memcpy(), const_column(), const_diagonal(), const_ptr(), const_row(), const_subcolumn(), const_subdiagonal(), const_submatrix(), const_subrow(), const_superdiagonal(), gsl::spmatrix_complex_double::d2sp(), diagonal(), div_elements(), fprintf(), fread(), fscanf(), fwrite(), gsl::eigen::genherm(), gsl::eigen::genhermv(), gsl::eigen::genhermv_sort(), gsl::eigen::genv(), gsl::eigen::genv_QZ(), gsl::eigen::genv_sort(), get_col(), get_row(), gsl::eigen::herm(), gsl::linalg::hermtd_decomp(), gsl::linalg::hermtd_unpack(), gsl::linalg::hermtd_unpack_T(), gsl::eigen::hermv(), gsl::eigen::hermv_sort(), isneg(), isnonneg(), isnull(), ispos(), matrix_complex(), memcpy(), mul_elements(), gsl::eigen::nonsymmv(), gsl::eigen::nonsymmv_sort(), gsl::eigen::nonsymmv_Z(), permute(), ptr(), row(), scale(), scale_columns(), scale_rows(), set(), set_all(), set_col(), set_identity(), set_row(), set_zero(), gsl::spmatrix_complex_double::sp2d(), sub(), subcolumn(), subdiagonal(), submatrix(), subrow(), superdiagonal(), swap_columns(), swap_rowcol(), swap_rows(), transpose(), transpose_memcpy(), transpose_tricpy(), tricpy(), gsl::blas::zgemm(), gsl::blas::zgemv(), gsl::blas::zgerc(), gsl::blas::zgeru(), gsl::blas::zhemm(), gsl::blas::zhemv(), gsl::blas::zher(), gsl::blas::zher2(), gsl::blas::zher2k(), gsl::blas::zherk(), gsl::blas::zsymm(), gsl::blas::zsyr2k(), gsl::blas::zsyrk(), gsl::blas::ztrmm(), gsl::blas::ztrmv(), gsl::blas::ztrsm(), and gsl::blas::ztrsv().

◆ get() [2/3]

gsl_matrix_complex const * gsl::matrix_complex::get ( ) const
inline

Get the gsl_matrix_complex.

Returns
the gsl_matrix_complex

Definition at line 1139 of file matrix_complex.hpp.

References ccgsl_pointer.

◆ get() [3/3]

complex gsl::matrix_complex::get ( size_t const  i,
size_t const  j 
) const
inline

C++ version of gsl_matrix_complex_get().

Parameters
iindex of row
jindex of column
Returns
value of element

Definition at line 1234 of file matrix_complex.hpp.

References get().

Referenced by get().

◆ get_col()

int gsl::matrix_complex::get_col ( vector_complex &  v,
size_t const  j 
) const
inline

C++ version of gsl_matrix_complex_get_col().

Parameters
vA vector_complex
jThe index of the column
Returns
error code on failure

Definition at line 1426 of file matrix_complex.hpp.

References get(), and gsl::vector_complex::get().

◆ get_row()

int gsl::matrix_complex::get_row ( vector_complex &  v,
size_t const  i 
) const
inline

C++ version of gsl_matrix_complex_get_row().

Parameters
vA vector_complex
iThe index of the row
Returns
error code on failure

Definition at line 1418 of file matrix_complex.hpp.

References get(), and gsl::vector_complex::get().

◆ isneg()

int gsl::matrix_complex::isneg ( ) const
inline

C++ version of gsl_matrix_complex_isneg().

Returns
+1 or 0 according as elements are all negative or not

Definition at line 1222 of file matrix_complex.hpp.

References get().

◆ isnonneg()

int gsl::matrix_complex::isnonneg ( ) const
inline

C++ version of gsl_matrix_complex_isnonneg().

Returns
+1 or 0 according as elements are all nonnegative or not

Definition at line 1227 of file matrix_complex.hpp.

References get().

◆ isnull()

int gsl::matrix_complex::isnull ( ) const
inline

C++ version of gsl_matrix_complex_isnull().

Returns
+1 or 0 according as elements are all zero or not

Definition at line 1212 of file matrix_complex.hpp.

References get().

◆ ispos()

int gsl::matrix_complex::ispos ( ) const
inline

C++ version of gsl_matrix_complex_ispos().

Returns
+1 or 0 according as elements are all positive or not

Definition at line 1217 of file matrix_complex.hpp.

References get().

◆ memcpy()

int gsl::matrix_complex::memcpy ( matrix_complex const &  src)
inline

C++ version of gsl_matrix_complex_memcpy().

Parameters
srcsource matrix_complex
Returns
error code on failure

Definition at line 1183 of file matrix_complex.hpp.

References get().

◆ mul_elements()

int gsl::matrix_complex::mul_elements ( matrix_complex const &  b)
inline

C++ version of gsl_matrix_complex_mul_elements().

Multiply matrices elementwise.

Parameters
bAnother matrix_complex
Returns
error code on failure

Definition at line 1374 of file matrix_complex.hpp.

References gsl::sf::mathieu::b(), and get().

◆ operator bool()

gsl::matrix_complex::operator bool ( ) const
inlineexplicit

Allow conversion to bool.

Returns
true or false according as this contains a pointer to a gsl_matrix_complex

Definition at line 1159 of file matrix_complex.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

matrix_complex & gsl::matrix_complex::operator= ( matrix_complex &&  v)
inline

Move operator.

Parameters
vThe matrix_complex to move.
Returns
A reference to this.

Definition at line 205 of file matrix_complex.hpp.

References matrix_complex().

◆ operator=() [2/2]

matrix_complex & gsl::matrix_complex::operator= ( matrix_complex const &  v)
inline

The assignment operator.

This makes a shared copy.

Parameters
vThe matrix_complex to copy

Definition at line 148 of file matrix_complex.hpp.

References ccgsl_pointer, and count.

◆ operator[]() [1/2]

vector_complex gsl::matrix_complex::operator[] ( size_t const  i)
inline

This function allows us to use a matrix_complex like an array.

Use with caution. Although matrix_complex[i][j] is possible, it is much less efficient than matrix_complex::set(). The effect is the same as row()

Parameters
iThe index of the row
Returns
A vector_complex representing a row

Definition at line 1452 of file matrix_complex.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAILED, and gsl::vector_complex::wrap_gsl_vector_complex_without_ownership().

◆ operator[]() [2/2]

vector_complex const gsl::matrix_complex::operator[] ( size_t const  i) const
inline

This function allows us to use a matrix_complex like an array.

Use with caution. Although matrix_complex[i][j] is possible, it is much less efficient than matrix_complex::set(). The effect is the same as row()

Parameters
iThe index of the row
Returns
A vector_complex representing a row

Definition at line 1470 of file matrix_complex.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAILED, and gsl::vector_complex::wrap_gsl_vector_complex_without_ownership().

◆ permute()

int gsl::matrix_complex::permute ( permutation &  p)
inline

Permute the columns of this by permutation p.

Parameters
pThe permutation
Returns
Error code on failure

Definition at line 1487 of file matrix_complex.hpp.

References get(), and gsl::permutation::get().

◆ ptr()

complex_ptr gsl::matrix_complex::ptr ( size_t const  i,
size_t const  j 
)
inline

C++ version of gsl_matrix_complex_ptr().

Parameters
iindex of row
jindex of column
Returns
pointer to element

Definition at line 1248 of file matrix_complex.hpp.

References CCGSL_MTY, ccgsl_pointer, get(), and gsl::exception::GSL_EINVAL.

Referenced by gsl::matrix_complex::iterator_base< container, content, reverse_t >::operator->().

◆ rbegin() [1/2]

reverse_iterator gsl::matrix_complex::rbegin ( )
inline

Get iterator pointing to first vector_complex element.

Returns
iterator pointing to first vector_complex element

Definition at line 639 of file matrix_complex.hpp.

References ccgsl_pointer, and size1().

◆ rbegin() [2/2]

const_reverse_iterator gsl::matrix_complex::rbegin ( ) const
inline

Get iterator pointing to first vector_complex element.

Returns
iterator pointing to first vector_complex element

Definition at line 647 of file matrix_complex.hpp.

References ccgsl_pointer, and size1().

◆ rend() [1/2]

reverse_iterator gsl::matrix_complex::rend ( )
inline

Get iterator pointing beyond last vector_complex element.

Returns
iterator pointing beyond last vector_complex element

Definition at line 656 of file matrix_complex.hpp.

◆ rend() [2/2]

const_reverse_iterator gsl::matrix_complex::rend ( ) const
inline

Get iterator pointing beyond last vector_complex element.

Returns
iterator pointing beyond last vector_complex element

Definition at line 663 of file matrix_complex.hpp.

◆ reset()

void gsl::matrix_complex::reset ( )
inline

Stop sharing ownership of the shared pointer.

Definition at line 190 of file matrix_complex.hpp.

References matrix_complex().

◆ row() [1/2]

vector_complex gsl::matrix_complex::row ( size_t const  i)
inline

C++ version of gsl_matrix_complex_row().

Parameters
iA row index
Returns
A row as a vector_complex

Definition at line 724 of file matrix_complex.hpp.

References get().

Referenced by matrix_complex().

◆ row() [2/2]

vector_complex const gsl::matrix_complex::row ( size_t const  i) const
inline

Another C++ version of gsl_matrix_complex_const_row().

Parameters
iA row index
Returns
A row as a vector_complex

Definition at line 999 of file matrix_complex.hpp.

References get().

◆ scale()

int gsl::matrix_complex::scale ( complex const  x)
inline

C++ version of gsl_matrix_complex_scale().

Parameters
xconstant to multiply this by
Returns
error code on failure

Definition at line 1201 of file matrix_complex.hpp.

References get().

◆ scale_columns()

int gsl::matrix_complex::scale_columns ( vector_complex const &  x)
inline

C++ version of gsl_matrix_complex_scale_columns().

Parameters
xA scalar
Returns
Error code on failure

Definition at line 1403 of file matrix_complex.hpp.

References get(), and gsl::vector_complex::get().

◆ scale_rows()

int gsl::matrix_complex::scale_rows ( vector_complex const &  x)
inline

C++ version of gsl_matrix_complex_scale_rows().

Parameters
xA scalar
Returns
Error code on failure

Definition at line 1396 of file matrix_complex.hpp.

References get(), and gsl::vector_complex::get().

◆ set()

void gsl::matrix_complex::set ( size_t const  i,
size_t const  j,
complex  x 
)
inline

C++ version of gsl_matrix_complex_set().

Parameters
iindex of row
jindex of column
xnew value for element

Definition at line 1241 of file matrix_complex.hpp.

References get().

Referenced by matrix_complex().

◆ set_all()

void gsl::matrix_complex::set_all ( complex  x)
inline

C++ version of gsl_matrix_complex_set_all().

Parameters
xThe value to which all elements are set

Definition at line 1177 of file matrix_complex.hpp.

References get().

◆ set_col()

int gsl::matrix_complex::set_col ( size_t const  j,
vector_complex const &  v 
)
inline

C++ version of gsl_matrix_complex_set_col().

Parameters
jThe index of the column
vA vector_complex
Returns
error code on failure

Definition at line 1442 of file matrix_complex.hpp.

References get(), and gsl::vector_complex::get().

◆ set_identity()

void gsl::matrix_complex::set_identity ( )
inline

C++ version of gsl_matrix_complex_set_identity().

Definition at line 1332 of file matrix_complex.hpp.

References get().

◆ set_row()

int gsl::matrix_complex::set_row ( size_t const  i,
vector_complex const &  v 
)
inline

C++ version of gsl_matrix_complex_set_row().

Parameters
iThe index of the row
vA vector_complex
Returns
error code on failure

Definition at line 1434 of file matrix_complex.hpp.

References get(), and gsl::vector_complex::get().

◆ set_zero()

void gsl::matrix_complex::set_zero ( )
inline

C++ version of gsl_matrix_complex_set_zero().

Definition at line 1172 of file matrix_complex.hpp.

References get().

◆ size1()

size_t gsl::matrix_complex::size1 ( ) const
inline

The number of rows of the matrix_complex.

Returns
The number of rows of the matrix_complex

Definition at line 672 of file matrix_complex.hpp.

References ccgsl_pointer.

Referenced by clone(), gsl::matrix_complex::iterator_base< container, content, reverse_t >::decrement(), end(), gsl::matrix_complex::iterator_base< container, content, reverse_t >::increment(), and rbegin().

◆ size2()

size_t gsl::matrix_complex::size2 ( ) const
inline

The number of columns of the matrix_complex.

Returns
The number of columns of the matrix_complex

Definition at line 677 of file matrix_complex.hpp.

References ccgsl_pointer.

Referenced by clone().

◆ sub()

int gsl::matrix_complex::sub ( matrix_complex const &  b)
inline

C++ version of gsl_matrix_complex_sub().

Parameters
bmatrix_complex to subtract from this
Returns
error code on failure

Definition at line 1195 of file matrix_complex.hpp.

References gsl::sf::mathieu::b(), and get().

◆ subcolumn() [1/2]

vector_complex gsl::matrix_complex::subcolumn ( size_t const  j,
size_t const  offset,
size_t const  n 
)
inline

C++ version of gsl_matrix_complex_subcolumn().

Parameters
jA column index
offsetA row offset
nThe number of elements
Returns
A subcolumn as a vector_complex

Definition at line 787 of file matrix_complex.hpp.

References get(), and gsl::rstat::n().

◆ subcolumn() [2/2]

vector_complex const gsl::matrix_complex::subcolumn ( size_t const  j,
size_t const  offset,
size_t const  n 
) const
inline

Another C++ version of gsl_matrix_complex_const_subcolumn().

Parameters
jA column index
offsetA row offset
nThe number of elements
Returns
A subcolumn as a vector_complex

Definition at line 1062 of file matrix_complex.hpp.

References get(), and gsl::rstat::n().

◆ subdiagonal() [1/2]

vector_complex gsl::matrix_complex::subdiagonal ( size_t const  k)
inline

C++ version of gsl_matrix_complex_subdiagonal().

Parameters
kAn index
Returns
Subdiagonal k as a vector_complex

Definition at line 753 of file matrix_complex.hpp.

References get().

◆ subdiagonal() [2/2]

vector_complex const gsl::matrix_complex::subdiagonal ( size_t const  k) const
inline

Another C++ version of gsl_matrix_complex_const_subdiagonal().

Parameters
kAn index
Returns
Subdiagonal k as a vector_complex

Definition at line 1028 of file matrix_complex.hpp.

References get().

◆ submatrix() [1/2]

matrix_complex gsl::matrix_complex::submatrix ( size_t const  i,
size_t const  j,
size_t const  n1,
size_t const  n2 
)
inline

C++ version of gsl_matrix_complex_submatrix().

Parameters
iIndex in this of first row of submatrix
jIndex in this of first column of submatrix
n1Number of rows of submatrix
n2Number of columns of submatrix
Returns
The submatrix

Definition at line 714 of file matrix_complex.hpp.

References get(), and matrix_complex().

◆ submatrix() [2/2]

matrix_complex const gsl::matrix_complex::submatrix ( size_t const  i,
size_t const  j,
size_t const  n1,
size_t const  n2 
) const
inline

Another C++ version of gsl_matrix_complex_const_submatrix().

Parameters
iIndex in this of first row of submatrix
jIndex in this of first column of submatrix
n1Number of rows of submatrix
n2Number of columns of submatrix
Returns
The submatrix

Definition at line 989 of file matrix_complex.hpp.

References get(), and matrix_complex().

◆ subrow() [1/2]

vector_complex gsl::matrix_complex::subrow ( size_t const  i,
size_t const  offset,
size_t const  n 
)
inline

C++ version of gsl_matrix_complex_subrow().

Parameters
iA row index
offsetA column offset
nThe number of elements
Returns
A subrow as a vector_complex

Definition at line 775 of file matrix_complex.hpp.

References get(), and gsl::rstat::n().

◆ subrow() [2/2]

vector_complex const gsl::matrix_complex::subrow ( size_t const  i,
size_t const  offset,
size_t const  n 
) const
inline

Another C++ version of gsl_matrix_complex_const_subrow().

Parameters
iA row index
offsetA column offset
nThe number of elements
Returns
A subrow as a vector_complex

Definition at line 1050 of file matrix_complex.hpp.

References get(), and gsl::rstat::n().

◆ superdiagonal() [1/2]

vector_complex gsl::matrix_complex::superdiagonal ( size_t const  k)
inline

C++ version of gsl_matrix_complex_superdiagonal().

Parameters
kAn index
Returns
Subdiagonal k as a vector_complex

Definition at line 763 of file matrix_complex.hpp.

References get().

◆ superdiagonal() [2/2]

vector_complex const gsl::matrix_complex::superdiagonal ( size_t const  k) const
inline

Another C++ version of gsl_matrix_complex_const_superdiagonal().

Parameters
kAn index
Returns
Subdiagonal k as a vector_complex

Definition at line 1038 of file matrix_complex.hpp.

References get().

◆ swap()

void gsl::matrix_complex::swap ( matrix_complex &  m)
inline

Swap two matrix_complex objects.

This works even if the matrix_complex objects have different sizes because it swaps pointers.

Parameters
mThe matrix_complex to swap with this.

Definition at line 683 of file matrix_complex.hpp.

References ccgsl_pointer, and count.

◆ swap_columns()

int gsl::matrix_complex::swap_columns ( size_t const  i,
size_t const  j 
)
inline

C++ version of gsl_matrix_complex_swap_columns().

Parameters
iIndex of first column
jIndex of second column
Returns
error code on failure

Definition at line 1346 of file matrix_complex.hpp.

References get().

◆ swap_rowcol()

int gsl::matrix_complex::swap_rowcol ( size_t const  i,
size_t const  j 
)
inline

C++ version of gsl_matrix_complex_swap_rowcol().

Swap row and column in place. Matrix must be square.

Parameters
iindex of row
jindex of column
Returns
error code on failure

Definition at line 1355 of file matrix_complex.hpp.

References get().

◆ swap_rows()

int gsl::matrix_complex::swap_rows ( size_t const  i,
size_t const  j 
)
inline

C++ version of gsl_matrix_complex_swap_rows().

Parameters
iIndex of first row
jIndex of second row
Returns
error code on failure

Definition at line 1339 of file matrix_complex.hpp.

References get().

◆ transpose()

int gsl::matrix_complex::transpose ( )
inline

C++ version of gsl_matrix_complex_transpose().

Returns
error code on failure.

Definition at line 1360 of file matrix_complex.hpp.

References get().

◆ transpose_memcpy()

int gsl::matrix_complex::transpose_memcpy ( matrix_complex const &  src)
inline

C++ version of gsl_matrix_complex_transpose_memcpy().

Parameters
srcmatrix_complex whose transpose it to be copied to this
Returns
error code on failure

Definition at line 1366 of file matrix_complex.hpp.

References get().

◆ transpose_tricpy()

void gsl::matrix_complex::transpose_tricpy ( CBLAS_UPLO_t  Uplo,
CBLAS_DIAG_t  Diag,
matrix_complex const &  src 
)
inline

Copy the upper or lower triangular part of matrix src to this.

Parameters
UploUpper or lower triangle: CblasUpper or CBlasLower
DiagDiagonal type
srcThe matrix to copy from

Definition at line 702 of file matrix_complex.hpp.

References get().

◆ tricpy()

void gsl::matrix_complex::tricpy ( CBLAS_UPLO_t  Uplo,
CBLAS_DIAG_t  Diag,
matrix_complex const &  src 
)
inline

Copy the upper or lower triangular part of matrix src to this.

Parameters
UploUpper or lower triangle: CblasUpper or CBlasLower
DiagDiagonal type
srcThe matrix to copy from

Definition at line 693 of file matrix_complex.hpp.

References get().

◆ unique()

bool gsl::matrix_complex::unique ( ) const
inline

Find if this is the only object sharing the gsl_matrix_complex.

Returns
true or falses according as this is the only matrix_complex object sharing the gsl_matrix_complex

Definition at line 1145 of file matrix_complex.hpp.

References count.

◆ use_count()

size_t gsl::matrix_complex::use_count ( ) const
inline

Find how many matrix_complex objects share this pointer.

Returns
the number of matrix_complex objects that share this pointer

Definition at line 1150 of file matrix_complex.hpp.

References count.

◆ view_array() [1/2]

static matrix_complex gsl::matrix_complex::view_array ( double *  base,
size_t const  n1,
size_t const  n2 
)
inlinestatic

C++ version of gsl_matrix_complex_view_array().

Parameters
baseAn array of type double
n1The number of rows
n2The number of columns
Returns
A matrix_complex

Definition at line 799 of file matrix_complex.hpp.

References matrix_complex().

◆ view_array() [2/2]

static matrix_complex const gsl::matrix_complex::view_array ( double const *  base,
size_t const  n1,
size_t const  n2 
)
inlinestatic

Another C++ version of gsl_matrix_complex_const_view_array().

Parameters
baseAn array of type double
n1The number of rows
n2The number of columns
Returns
A matrix_complex

Definition at line 1074 of file matrix_complex.hpp.

References matrix_complex().

◆ view_array_with_tda() [1/2]

static matrix_complex gsl::matrix_complex::view_array_with_tda ( double *  base,
size_t const  n1,
size_t const  n2,
size_t const  tda 
)
inlinestatic

C++ version of gsl_matrix_complex_view_array_with_tda().

Parameters
baseAn array of type double
n1The number of rows
n2The number of columns
tdaThe number of columns in memory
Returns
A matrix_complex

Definition at line 812 of file matrix_complex.hpp.

References matrix_complex().

◆ view_array_with_tda() [2/2]

static matrix_complex const gsl::matrix_complex::view_array_with_tda ( double const *  base,
size_t const  n1,
size_t const  n2,
size_t const  tda 
)
inlinestatic

Another C++ version of gsl_matrix_complex_const_view_array_with_tda().

Parameters
baseAn array of type double
n1The number of rows
n2The number of columns
tdaThe number of columns in memory
Returns
A matrix_complex

Definition at line 1088 of file matrix_complex.hpp.

References matrix_complex().

◆ view_vector() [1/2]

static matrix_complex gsl::matrix_complex::view_vector ( vector_complex &  v,
size_t const  n1,
size_t const  n2 
)
inlinestatic

C++ version of gsl_matrix_complex_view_vector().

Parameters
vA vector_complex
n1The number of rows
n2The number of columns
Returns
A matrix_complex

Definition at line 824 of file matrix_complex.hpp.

References gsl::vector_complex::get(), and matrix_complex().

◆ view_vector() [2/2]

static matrix_complex const gsl::matrix_complex::view_vector ( vector_complex const &  v,
size_t const  n1,
size_t const  n2 
)
inlinestatic

Another C++ version of gsl_matrix_complex_const_view_vector().

Parameters
vA vector_complex
n1The number of rows
n2The number of columns
Returns
A matrix_complex

Definition at line 1100 of file matrix_complex.hpp.

References gsl::vector_complex::get(), and matrix_complex().

◆ view_vector_with_tda() [1/2]

static matrix_complex gsl::matrix_complex::view_vector_with_tda ( vector_complex &  v,
size_t const  n1,
size_t const  n2,
size_t const  tda 
)
inlinestatic

C++ version of gsl_matrix_complex_view_vector_with_tda().

Parameters
vA vector_complex
n1The number of rows
n2The number of columns
tdaThe number of columns in memory
Returns
A matrix_complex

Definition at line 837 of file matrix_complex.hpp.

References gsl::vector_complex::get(), and matrix_complex().

◆ view_vector_with_tda() [2/2]

static matrix_complex const gsl::matrix_complex::view_vector_with_tda ( vector_complex const &  v,
size_t const  n1,
size_t const  n2,
size_t const  tda 
)
inlinestatic

Another C++ version of gsl_matrix_complex_const_view_vector_with_tda().

Parameters
vA vector_complex
n1The number of rows
n2The number of columns
tdaThe number of columns in memory
Returns
A matrix_complex

Definition at line 1114 of file matrix_complex.hpp.

References gsl::vector_complex::get(), and matrix_complex().

Member Data Documentation

◆ ccgsl_pointer

gsl_matrix_complex* gsl::matrix_complex::ccgsl_pointer
private

The shared pointer.

Definition at line 1123 of file matrix_complex.hpp.

Referenced by const_ptr(), end(), get(), matrix_complex(), operator bool(), operator=(), operator[](), ptr(), rbegin(), size1(), size2(), swap(), and ~matrix_complex().

◆ count

size_t* gsl::matrix_complex::count
private

The shared reference count.

Definition at line 1127 of file matrix_complex.hpp.

Referenced by matrix_complex(), operator=(), swap(), unique(), use_count(), and ~matrix_complex().

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