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

#include <matrix_complex_long_double.hpp>

Collaboration diagram for gsl::matrix_complex_long_double:

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_long_double_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_long_double ()
	The default constructor is only really useful for assigning to. More...

	matrix_complex_long_double (size_t const n1, size_t const n2)
	The default constructor creates a new matrix_complex_long_double with n1 * n1 elements. More...

	matrix_complex_long_double (gsl_matrix_complex_long_double *v)
	Could construct from a gsl_matrix_complex_long_double. More...

	matrix_complex_long_double (std::initializer_list< std::initializer_list< std::complex< long double > > > initializer_list)
	Could construct from a std::initializer_list in C++11. More...

	matrix_complex_long_double (matrix_complex_long_double const &v)
	The copy constructor. More...

matrix_complex_long_double &	operator= (matrix_complex_long_double const &v)
	The assignment operator. More...

matrix_complex_long_double	clone () const
	The clone function. More...

	~matrix_complex_long_double ()
	The destructor only deletes the pointers if count reaches zero. More...

void	reset ()
	Stop sharing ownership of the shared pointer. More...

	matrix_complex_long_double (matrix_complex_long_double &&v)
	Move constructor. More...

matrix_complex_long_double &	operator= (matrix_complex_long_double &&v)
	Move operator. More...

iterator	begin ()
	Get iterator pointing to first vector_complex_long_double element. More...

const_iterator	begin () const
	Get iterator pointing to first vector_complex_long_double element. More...

iterator	end ()
	Get iterator pointing beyond last vector_complex_long_double element. More...

const_iterator	end () const
	Get iterator pointing beyond last vector_complex_long_double element. More...

reverse_iterator	rbegin ()
	Get iterator pointing to first vector_complex_long_double element. More...

const_reverse_iterator	rbegin () const
	Get iterator pointing to first vector_complex_long_double element. More...

reverse_iterator	rend ()
	Get iterator pointing beyond last vector_complex_long_double element. More...

const_reverse_iterator	rend () const
	Get iterator pointing beyond last vector_complex_long_double element. More...

size_t	size1 () const
	The number of rows of the matrix_complex_long_double. More...

size_t	size2 () const
	The number of columns of the matrix_complex_long_double. More...

void	swap (matrix_complex_long_double &m)
	Swap two matrix_complex_long_double objects. More...

void	tricpy (CBLAS_UPLO_t Uplo, CBLAS_DIAG_t Diag, matrix_complex_long_double 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_long_double const &src)
	Copy the upper or lower triangular part of matrix src to `this`. More...

matrix_complex_long_double	submatrix (size_t const i, size_t const j, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_submatrix(). More...

vector_complex_long_double	row (size_t const i)
	C++ version of gsl_matrix_complex_long_double_row(). More...

vector_complex_long_double	column (size_t const j)
	C++ version of gsl_matrix_complex_long_double_column(). More...

vector_complex_long_double	diagonal ()
	C++ version of gsl_matrix_complex_long_double_diagonal(). More...

vector_complex_long_double	subdiagonal (size_t const k)
	C++ version of gsl_matrix_complex_long_double_subdiagonal(). More...

vector_complex_long_double	superdiagonal (size_t const k)
	C++ version of gsl_matrix_complex_long_double_superdiagonal(). More...

vector_complex_long_double	subrow (size_t const i, size_t const offset, size_t const n)
	C++ version of gsl_matrix_complex_long_double_subrow(). More...

vector_complex_long_double	subcolumn (size_t const j, size_t const offset, size_t const n)
	C++ version of gsl_matrix_complex_long_double_subcolumn(). More...

matrix_complex_long_double 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_long_double_const_submatrix(). More...

vector_complex_long_double const	const_row (size_t const i) const
	C++ version of gsl_matrix_complex_long_double_const_row(). More...

vector_complex_long_double const	const_column (size_t const j) const
	C++ version of gsl_matrix_complex_long_double_const_column(). More...

vector_complex_long_double const	const_diagonal () const
	C++ version of gsl_matrix_complex_long_double_const_diagonal(). More...

vector_complex_long_double const	const_subdiagonal (size_t const k) const
	C++ version of gsl_matrix_complex_long_double_const_subdiagonal(). More...

vector_complex_long_double const	const_superdiagonal (size_t const k) const
	C++ version of gsl_matrix_complex_long_double_const_superdiagonal(). More...

vector_complex_long_double const	const_subrow (size_t const i, size_t const offset, size_t const n) const
	C++ version of gsl_matrix_complex_long_double_const_subrow(). More...

vector_complex_long_double const	const_subcolumn (size_t const j, size_t const offset, size_t const n) const
	C++ version of gsl_matrix_complex_long_double_const_subcolumn(). More...

matrix_complex_long_double 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_long_double_const_submatrix(). More...

vector_complex_long_double const	row (size_t const i) const
	Another C++ version of gsl_matrix_complex_long_double_const_row(). More...

vector_complex_long_double const	column (size_t const j) const
	Another C++ version of gsl_matrix_complex_long_double_const_column(). More...

vector_complex_long_double const	diagonal () const
	Another C++ version of gsl_matrix_complex_long_double_const_diagonal(). More...

vector_complex_long_double const	subdiagonal (size_t const k) const
	Another C++ version of gsl_matrix_complex_long_double_const_subdiagonal(). More...

vector_complex_long_double const	superdiagonal (size_t const k) const
	Another C++ version of gsl_matrix_complex_long_double_const_superdiagonal(). More...

vector_complex_long_double const	subrow (size_t const i, size_t const offset, size_t const n) const
	Another C++ version of gsl_matrix_complex_long_double_const_subrow(). More...

vector_complex_long_double const	subcolumn (size_t const j, size_t const offset, size_t const n) const
	Another C++ version of gsl_matrix_complex_long_double_const_subcolumn(). More...

gsl_matrix_complex_long_double *	get ()
	Get the gsl_matrix_complex_long_double. More...

gsl_matrix_complex_long_double const *	get () const
	Get the gsl_matrix_complex_long_double. More...

bool	unique () const
	Find if this is the only object sharing the gsl_matrix_complex_long_double. More...

size_t	use_count () const
	Find how many matrix_complex_long_double objects share this pointer. More...

	operator bool () const
	Allow conversion to bool. More...

void	set_zero ()
	C++ version of gsl_matrix_complex_long_double_set_zero(). More...

void	set_all (complex_long_double x)
	C++ version of gsl_matrix_complex_long_double_set_all(). More...

int	memcpy (matrix_complex_long_double const &src)
	C++ version of gsl_matrix_complex_long_double_memcpy(). More...

int	add (matrix_complex_long_double const &b)
	C++ version of gsl_matrix_complex_long_double_add(). More...

int	sub (matrix_complex_long_double const &b)
	C++ version of gsl_matrix_complex_long_double_sub(). More...

int	scale (complex_long_double const x)
	C++ version of gsl_matrix_complex_long_double_scale(). More...

int	add_constant (complex_long_double const x)
	C++ version of gsl_matrix_complex_long_double_add_constant(). More...

int	isnull () const
	C++ version of gsl_matrix_complex_long_double_isnull(). More...

int	ispos () const
	C++ version of gsl_matrix_complex_long_double_ispos(). More...

int	isneg () const
	C++ version of gsl_matrix_complex_long_double_isneg(). More...

int	isnonneg () const
	C++ version of gsl_matrix_complex_long_double_isnonneg(). More...

complex_long_double	get (size_t const i, size_t const j) const
	C++ version of gsl_matrix_complex_long_double_get(). More...

void	set (size_t const i, size_t const j, complex_long_double x)
	C++ version of gsl_matrix_complex_long_double_set(). More...

complex_long_double_ptr	ptr (size_t const i, size_t const j)
	C++ version of gsl_matrix_complex_long_double_ptr(). More...

complex_long_double_ptr const	const_ptr (size_t const i, size_t const j) const
	C++ version of gsl_matrix_complex_long_double_const_ptr(). More...

int	fread (FILE *stream)
	C++ version of gsl_matrix_complex_long_double_fread(). More...

int	fwrite (FILE *stream) const
	C++ version of gsl_matrix_complex_long_double_fwrite(). More...

int	fscanf (FILE *stream)
	C++ version of gsl_matrix_complex_long_double_fscanf(). More...

int	fprintf (FILE stream, char const format) const
	C++ version of gsl_matrix_complex_long_double_fprintf(). More...

	matrix_complex_long_double (block_complex_long_double &b, size_t const offset, size_t const n1, size_t const n2, size_t const d2)
	C++ version of gsl_matrix_complex_long_double_alloc_from_block(). More...

	matrix_complex_long_double (matrix_complex_long_double &m, size_t const k1, size_t const k2, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_alloc_from_matrix(). More...

void	set_identity ()
	C++ version of gsl_matrix_complex_long_double_set_identity(). More...

int	swap_rows (size_t const i, size_t const j)
	C++ version of gsl_matrix_complex_long_double_swap_rows(). More...

int	swap_columns (size_t const i, size_t const j)
	C++ version of gsl_matrix_complex_long_double_swap_columns(). More...

int	swap_rowcol (size_t const i, size_t const j)
	C++ version of gsl_matrix_complex_long_double_swap_rowcol(). More...

int	transpose ()
	C++ version of gsl_matrix_complex_long_double_transpose(). More...

int	transpose_memcpy (matrix_complex_long_double const &src)
	C++ version of gsl_matrix_complex_long_double_transpose_memcpy(). More...

int	mul_elements (matrix_complex_long_double const &b)
	C++ version of gsl_matrix_complex_long_double_mul_elements(). More...

int	div_elements (matrix_complex_long_double const &b)
	C++ version of gsl_matrix_complex_long_double_div_elements(). More...

int	conjtrans_memcpy (matrix_complex_long_double const &src)
	C++ version of gsl_matrix_complex_long_double_conjtrans_memcpy(). More...

int	scale_rows (vector_complex_long_double const &x)
	C++ version of gsl_matrix_complex_long_double_scale_rows(). More...

int	scale_columns (vector_complex_long_double const &x)
	C++ version of gsl_matrix_complex_long_double_scale_columns(). More...

int	add_diagonal (complex_long_double const x)
	C++ version of gsl_matrix_complex_long_double_add_diagonal(). More...

int	get_row (vector_complex_long_double &v, size_t const i) const
	C++ version of gsl_matrix_complex_long_double_get_row(). More...

int	get_col (vector_complex_long_double &v, size_t const j) const
	C++ version of gsl_matrix_complex_long_double_get_col(). More...

int	set_row (size_t const i, vector_complex_long_double const &v)
	C++ version of gsl_matrix_complex_long_double_set_row(). More...

int	set_col (size_t const j, vector_complex_long_double const &v)
	C++ version of gsl_matrix_complex_long_double_set_col(). More...

vector_complex_long_double	operator[] (size_t const i)
	This function allows us to use a matrix_complex_long_double like an array. More...

vector_complex_long_double const	operator[] (size_t const i) const
	This function allows us to use a matrix_complex_long_double like an array. More...

int	permute (permutation &p)
	Permute the columns of `this` by permutation p. More...

Static Public Member Functions
static matrix_complex_long_double	view_array (long double *base, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_view_array(). More...

static matrix_complex_long_double	view_array_with_tda (long double *base, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_complex_long_double_view_array_with_tda(). More...

static matrix_complex_long_double	view_vector (vector_complex_long_double &v, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_view_vector(). More...

static matrix_complex_long_double	view_vector_with_tda (vector_complex_long_double &v, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_complex_long_double_view_vector_with_tda(). More...

static matrix_complex_long_double const	const_view_array (long double const *base, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_const_view_array(). More...

static matrix_complex_long_double const	const_view_array_with_tda (long double const *base, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_complex_long_double_const_view_array_with_tda(). More...

static matrix_complex_long_double const	const_view_vector (vector_complex_long_double const &v, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_const_view_vector(). More...

static matrix_complex_long_double const	const_view_vector_with_tda (vector_complex_long_double const &v, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_complex_long_double_const_view_vector_with_tda(). More...

static matrix_complex_long_double const	view_array (long double const *base, size_t const n1, size_t const n2)
	Another C++ version of gsl_matrix_complex_long_double_const_view_array(). More...

static matrix_complex_long_double const	view_array_with_tda (long double const *base, size_t const n1, size_t const n2, size_t const tda)
	Another C++ version of gsl_matrix_complex_long_double_const_view_array_with_tda(). More...

static matrix_complex_long_double const	view_vector (vector_complex_long_double const &v, size_t const n1, size_t const n2)
	Another C++ version of gsl_matrix_complex_long_double_const_view_vector(). More...

static matrix_complex_long_double const	view_vector_with_tda (vector_complex_long_double const &v, size_t const n1, size_t const n2, size_t const tda)
	Another C++ version of gsl_matrix_complex_long_double_const_view_vector_with_tda(). More...

static matrix_complex_long_double	calloc (size_t const n1, size_t const n2)
	C++ version of gsl_matrix_complex_long_double_calloc(). More...

Private Attributes
gsl_matrix_complex_long_double *	ccgsl_pointer
	The shared pointer. More...

size_t *	count
	The shared reference count. More...

Detailed Description

This class handles matrix_complex_long_double objects as shared handles.

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

Note that matrix_views are implemented as matrix_complex_long_double 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_long_double::row

vector_complex_long_double row(size_t const i)

C++ version of gsl_matrix_complex_long_double_row().

Definition: matrix_complex_long_double.hpp:726

gsl::matrix

This class handles matrix objects as shared handles.

Definition: matrix.hpp:72

Otherwise,

for( matrix_complex_long_double::iterator i = matrix.begin(); i != matrix.end(); ++i ){
  vector_complex_long_double row = *i;
  ...
}

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_long_double.hpp.

Member Typedef Documentation

◆ const_iterator

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

The const_iterator type.

Definition at line 585 of file matrix_complex_long_double.hpp.

◆ const_reverse_iterator

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

The const_reverse_t type.

Definition at line 593 of file matrix_complex_long_double.hpp.

◆ iterator

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

The iterator type.

Definition at line 589 of file matrix_complex_long_double.hpp.

◆ reverse_iterator

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

The reverse_iterator type.

Definition at line 597 of file matrix_complex_long_double.hpp.

◆ size_type

typedef size_t gsl::matrix_complex_long_double::size_type

A container must have a size_type.

Definition at line 601 of file matrix_complex_long_double.hpp.

Constructor & Destructor Documentation

◆ matrix_complex_long_double() [1/8]

gsl::matrix_complex_long_double::matrix_complex_long_double ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 67 of file matrix_complex_long_double.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_long_double() [2/8]

gsl::matrix_complex_long_double::matrix_complex_long_double	(	size_t const	n1,
		size_t const	n2
	)

inlineexplicit

The default constructor creates a new matrix_complex_long_double with n1 * n1 elements.

Parameters

n1	The number of rows in the matrix_complex_long_double
n2	The number of columns in the matrix_complex_long_double

Definition at line 78 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and count.

◆ matrix_complex_long_double() [3/8]

gsl::matrix_complex_long_double::matrix_complex_long_double ( gsl_matrix_complex_long_double * v )

inlineexplicit

Could construct from a gsl_matrix_complex_long_double.

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

Parameters

v	The matrix_complex_long_double

Definition at line 96 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and count.

◆ matrix_complex_long_double() [4/8]

gsl::matrix_complex_long_double::matrix_complex_long_double ( std::initializer_list< std::initializer_list< std::complex< long double > > > initializer_list )

inline

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

Parameters

initializer_list The initializer_list.

Definition at line 107 of file matrix_complex_long_double.hpp.

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

◆ matrix_complex_long_double() [5/8]

gsl::matrix_complex_long_double::matrix_complex_long_double ( matrix_complex_long_double const & v )

inline

The copy constructor.

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

Parameters

v	The matrix_complex_long_double to copy.

Definition at line 140 of file matrix_complex_long_double.hpp.

References count.

◆ ~matrix_complex_long_double()

gsl::matrix_complex_long_double::~matrix_complex_long_double ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 178 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and count.

◆ matrix_complex_long_double() [6/8]

gsl::matrix_complex_long_double::matrix_complex_long_double ( matrix_complex_long_double && v )

inline

Move constructor.

Parameters

v	The matrix_complex_long_double to move.

Definition at line 196 of file matrix_complex_long_double.hpp.

References count.

◆ matrix_complex_long_double() [7/8]

gsl::matrix_complex_long_double::matrix_complex_long_double	(	block_complex_long_double &	b,
		size_t const	offset,
		size_t const	n1,
		size_t const	n2,
		size_t const	d2
	)

inline

C++ version of gsl_matrix_complex_long_double_alloc_from_block().

Parameters

b	The block_complex_long_double
offset	The offset within the block_complex_long_double
n1	The number of rows in the matrix_complex_long_double
n2	The number of columns in the matrix_complex_long_double
d2	undocumented

Definition at line 1302 of file matrix_complex_long_double.hpp.

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

◆ matrix_complex_long_double() [8/8]

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

inline

C++ version of gsl_matrix_complex_long_double_alloc_from_matrix().

Parameters

m	The matrix_complex_long_double
k1	the row of `m` to take as row zero
k2	the column of `m` to take as column zero
n1	The number of rows in the matrix_complex_long_double
n2	The number of columns in the matrix_complex_long_double

Definition at line 1320 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, count, and get().

Member Function Documentation

◆ add()

int gsl::matrix_complex_long_double::add ( matrix_complex_long_double const & b )

inline

C++ version of gsl_matrix_complex_long_double_add().

Parameters

b	matrix_complex_long_double to add to this

Returns: error code on failure

Definition at line 1191 of file matrix_complex_long_double.hpp.

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

◆ add_constant()

int gsl::matrix_complex_long_double::add_constant ( complex_long_double const x )

inline

C++ version of gsl_matrix_complex_long_double_add_constant().

Parameters

x	constant to add to each element of this

Returns: error code on failure

Definition at line 1209 of file matrix_complex_long_double.hpp.

References get().

◆ add_diagonal()

int gsl::matrix_complex_long_double::add_diagonal ( complex_long_double const x )

inline

C++ version of gsl_matrix_complex_long_double_add_diagonal().

Parameters

x	A constant

Returns: error code on failure

Definition at line 1412 of file matrix_complex_long_double.hpp.

References get().

◆ begin() [1/2]

iterator gsl::matrix_complex_long_double::begin ( )

inline

Get iterator pointing to first vector_complex_long_double element.

Returns: iterator pointing to first vector_complex_long_double element

Definition at line 607 of file matrix_complex_long_double.hpp.

◆ begin() [2/2]

const_iterator gsl::matrix_complex_long_double::begin ( ) const

inline

Get iterator pointing to first vector_complex_long_double element.

Returns: iterator pointing to first vector_complex_long_double element

Definition at line 614 of file matrix_complex_long_double.hpp.

◆ calloc()

static matrix_complex_long_double gsl::matrix_complex_long_double::calloc	(	size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_calloc().

This constructs a matrix_complex_long_double object with entries initialised to zero.

Parameters

n1	The number of rows in the matrix_complex_long_double
n2	The number of columns in the matrix_complex_long_double

Returns: A matrix_complex_long_double initialised to zero

Definition at line 1170 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ clone()

matrix_complex_long_double gsl::matrix_complex_long_double::clone ( ) const

inline

The clone function.

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

Returns: a new copy of this.

Definition at line 167 of file matrix_complex_long_double.hpp.

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

◆ column() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::column ( size_t const j )

inline

C++ version of gsl_matrix_complex_long_double_column().

Parameters

j	A column index

Returns: A column as a vector_complex_long_double

Definition at line 736 of file matrix_complex_long_double.hpp.

References get().

◆ column() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::column ( size_t const j ) const

inline

Another C++ version of gsl_matrix_complex_long_double_const_column().

Parameters

j	A column index

Returns: A column as a vector_complex_long_double

Definition at line 1011 of file matrix_complex_long_double.hpp.

References get().

◆ conjtrans_memcpy()

int gsl::matrix_complex_long_double::conjtrans_memcpy ( matrix_complex_long_double const & src )

inline

C++ version of gsl_matrix_complex_long_double_conjtrans_memcpy().

Parameters

src	Source matrix

Returns: error code on failure

Definition at line 1391 of file matrix_complex_long_double.hpp.

References get().

◆ const_column()

vector_complex_long_double const gsl::matrix_complex_long_double::const_column ( size_t const j ) const

inline

C++ version of gsl_matrix_complex_long_double_const_column().

Parameters

j	A column index

Returns: A column as a vector_complex_long_double

Definition at line 873 of file matrix_complex_long_double.hpp.

References get().

◆ const_diagonal()

vector_complex_long_double const gsl::matrix_complex_long_double::const_diagonal ( ) const

inline

C++ version of gsl_matrix_complex_long_double_const_diagonal().

Returns: The principal diagonal as a vector_complex_long_double

Definition at line 882 of file matrix_complex_long_double.hpp.

References get().

◆ const_ptr()

complex_long_double_ptr const gsl::matrix_complex_long_double::const_ptr	(	size_t const	i,
		size_t const	j
	)		const

inline

C++ version of gsl_matrix_complex_long_double_const_ptr().

Parameters

i	index of row
j	index of column

Returns: pointer to element

Definition at line 1262 of file matrix_complex_long_double.hpp.

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

◆ const_row()

vector_complex_long_double const gsl::matrix_complex_long_double::const_row ( size_t const i ) const

inline

C++ version of gsl_matrix_complex_long_double_const_row().

Parameters

i	A row index

Returns: A row as a vector_complex_long_double

Definition at line 863 of file matrix_complex_long_double.hpp.

References get().

◆ const_subcolumn()

vector_complex_long_double const gsl::matrix_complex_long_double::const_subcolumn	(	size_t const	j,
		size_t const	offset,
		size_t const	n
	)		const

inline

C++ version of gsl_matrix_complex_long_double_const_subcolumn().

Parameters

j	A column index
offset	A row offset
n	The number of elements

Returns: A subcolumn as a vector_complex_long_double

Definition at line 926 of file matrix_complex_long_double.hpp.

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

◆ const_subdiagonal()

vector_complex_long_double const gsl::matrix_complex_long_double::const_subdiagonal ( size_t const k ) const

inline

C++ version of gsl_matrix_complex_long_double_const_subdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_complex_long_double

Definition at line 892 of file matrix_complex_long_double.hpp.

References get().

◆ const_submatrix()

matrix_complex_long_double const gsl::matrix_complex_long_double::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_long_double_const_submatrix().

Parameters

i	Index in `this` of first row of submatrix
j	Index in `this` of first column of submatrix
n1	Number of rows of submatrix
n2	Number of columns of submatrix

Returns: The submatrix

Definition at line 853 of file matrix_complex_long_double.hpp.

References get(), and matrix_complex_long_double().

◆ const_subrow()

vector_complex_long_double const gsl::matrix_complex_long_double::const_subrow	(	size_t const	i,
		size_t const	offset,
		size_t const	n
	)		const

inline

C++ version of gsl_matrix_complex_long_double_const_subrow().

Parameters

i	A row index
offset	A column offset
n	The number of elements

Returns: A subrow as a vector_complex_long_double

Definition at line 914 of file matrix_complex_long_double.hpp.

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

◆ const_superdiagonal()

vector_complex_long_double const gsl::matrix_complex_long_double::const_superdiagonal ( size_t const k ) const

inline

C++ version of gsl_matrix_complex_long_double_const_superdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_complex_long_double

Definition at line 902 of file matrix_complex_long_double.hpp.

References get().

◆ const_view_array()

static matrix_complex_long_double const gsl::matrix_complex_long_double::const_view_array	(	long double const *	base,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_const_view_array().

Parameters

base	An array of type long double
n1	The number of rows
n2	The number of columns

Returns: A matrix_complex_long_double

Definition at line 938 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ const_view_array_with_tda()

static matrix_complex_long_double const gsl::matrix_complex_long_double::const_view_array_with_tda	(	long double const *	base,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_const_view_array_with_tda().

Parameters

base	An array of type long double
n1	The number of rows
n2	The number of columns
tda	The number of columns in memory

Returns: A matrix_complex_long_double

Definition at line 952 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ const_view_vector()

static matrix_complex_long_double const gsl::matrix_complex_long_double::const_view_vector	(	vector_complex_long_double const &	v,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_const_view_vector().

Parameters

v	A vector_complex_long_double
n1	The number of rows
n2	The number of columns

Returns: A matrix_complex_long_double

Definition at line 964 of file matrix_complex_long_double.hpp.

References gsl::vector_complex_long_double::get(), and matrix_complex_long_double().

◆ const_view_vector_with_tda()

static matrix_complex_long_double const gsl::matrix_complex_long_double::const_view_vector_with_tda	(	vector_complex_long_double const &	v,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_const_view_vector_with_tda().

Parameters

v	A vector_complex_long_double
n1	The number of rows
n2	The number of columns
tda	The number of columns in memory

Returns: A matrix_complex_long_double

Definition at line 978 of file matrix_complex_long_double.hpp.

References gsl::vector_complex_long_double::get(), and matrix_complex_long_double().

◆ diagonal() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::diagonal ( )

inline

C++ version of gsl_matrix_complex_long_double_diagonal().

Returns: The principal diagonal as a vector_complex_long_double

Definition at line 746 of file matrix_complex_long_double.hpp.

References get().

◆ diagonal() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::diagonal ( ) const

inline

Another C++ version of gsl_matrix_complex_long_double_const_diagonal().

Returns: The principal diagonal as a vector_complex_long_double

Definition at line 1020 of file matrix_complex_long_double.hpp.

References get().

◆ div_elements()

int gsl::matrix_complex_long_double::div_elements ( matrix_complex_long_double const & b )

inline

C++ version of gsl_matrix_complex_long_double_div_elements().

Divide each element of this by the corrsponding element of b

Parameters

b	Another matrix_complex_long_double

Returns: error code on failure

Definition at line 1384 of file matrix_complex_long_double.hpp.

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

◆ end() [1/2]

iterator gsl::matrix_complex_long_double::end ( )

inline

Get iterator pointing beyond last vector_complex_long_double element.

Returns: iterator pointing beyond last vector_complex_long_double element

Definition at line 622 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and size1().

◆ end() [2/2]

const_iterator gsl::matrix_complex_long_double::end ( ) const

inline

Get iterator pointing beyond last vector_complex_long_double element.

Returns: iterator pointing beyond last vector_complex_long_double element

Definition at line 630 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and size1().

◆ fprintf()

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

inline

C++ version of gsl_matrix_complex_long_double_fprintf().

Parameters

stream	A C file stream
format	d, e, f or g

Returns: error code on failure

Definition at line 1292 of file matrix_complex_long_double.hpp.

References get().

◆ fread()

int gsl::matrix_complex_long_double::fread ( FILE * stream )

inline

C++ version of gsl_matrix_complex_long_double_fread().

Parameters

stream A C file stream

Returns: error code on failure

Definition at line 1273 of file matrix_complex_long_double.hpp.

References get().

◆ fscanf()

int gsl::matrix_complex_long_double::fscanf ( FILE * stream )

inline

C++ version of gsl_matrix_complex_long_double_fscanf().

Parameters

stream A C file stream

Returns: error code on failure

Definition at line 1285 of file matrix_complex_long_double.hpp.

References get().

◆ fwrite()

int gsl::matrix_complex_long_double::fwrite ( FILE * stream ) const

inline

C++ version of gsl_matrix_complex_long_double_fwrite().

Parameters

stream A C file stream

Returns: error code on failure

Definition at line 1279 of file matrix_complex_long_double.hpp.

References get().

◆ get() [1/3]

gsl_matrix_complex_long_double * gsl::matrix_complex_long_double::get ( )

inline

Get the gsl_matrix_complex_long_double.

Returns: the gsl_matrix_complex_long_double

Definition at line 1136 of file matrix_complex_long_double.hpp.

References ccgsl_pointer.

Referenced by add(), add_constant(), add_diagonal(), clone(), column(), conjtrans_memcpy(), const_column(), const_diagonal(), const_ptr(), const_row(), const_subcolumn(), const_subdiagonal(), const_submatrix(), const_subrow(), const_superdiagonal(), gsl::spmatrix_complex_long_double::d2sp(), diagonal(), div_elements(), fprintf(), fread(), fscanf(), fwrite(), get_col(), get_row(), isneg(), isnonneg(), isnull(), ispos(), matrix_complex_long_double(), memcpy(), mul_elements(), permute(), ptr(), row(), scale(), scale_columns(), scale_rows(), set(), set_all(), set_col(), set_identity(), set_row(), set_zero(), gsl::spmatrix_complex_long_double::sp2d(), sub(), subcolumn(), subdiagonal(), submatrix(), subrow(), superdiagonal(), swap_columns(), swap_rowcol(), swap_rows(), transpose(), transpose_memcpy(), transpose_tricpy(), and tricpy().

◆ get() [2/3]

gsl_matrix_complex_long_double const * gsl::matrix_complex_long_double::get ( ) const

inline

Get the gsl_matrix_complex_long_double.

Returns: the gsl_matrix_complex_long_double

Definition at line 1141 of file matrix_complex_long_double.hpp.

References ccgsl_pointer.

◆ get() [3/3]

complex_long_double gsl::matrix_complex_long_double::get	(	size_t const	i,
		size_t const	j
	)		const

inline

C++ version of gsl_matrix_complex_long_double_get().

Parameters

i	index of row
j	index of column

Returns: value of element

Definition at line 1236 of file matrix_complex_long_double.hpp.

References get().

Referenced by get().

◆ get_col()

int gsl::matrix_complex_long_double::get_col	(	vector_complex_long_double &	v,
		size_t const	j
	)		const

inline

C++ version of gsl_matrix_complex_long_double_get_col().

Parameters

v	A vector_complex_long_double
j	The index of the column

Returns: error code on failure

Definition at line 1428 of file matrix_complex_long_double.hpp.

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

◆ get_row()

int gsl::matrix_complex_long_double::get_row	(	vector_complex_long_double &	v,
		size_t const	i
	)		const

inline

C++ version of gsl_matrix_complex_long_double_get_row().

Parameters

v	A vector_complex_long_double
i	The index of the row

Returns: error code on failure

Definition at line 1420 of file matrix_complex_long_double.hpp.

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

◆ isneg()

int gsl::matrix_complex_long_double::isneg ( ) const

inline

C++ version of gsl_matrix_complex_long_double_isneg().

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

Definition at line 1224 of file matrix_complex_long_double.hpp.

References get().

◆ isnonneg()

int gsl::matrix_complex_long_double::isnonneg ( ) const

inline

C++ version of gsl_matrix_complex_long_double_isnonneg().

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

Definition at line 1229 of file matrix_complex_long_double.hpp.

References get().

◆ isnull()

int gsl::matrix_complex_long_double::isnull ( ) const

inline

C++ version of gsl_matrix_complex_long_double_isnull().

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

Definition at line 1214 of file matrix_complex_long_double.hpp.

References get().

◆ ispos()

int gsl::matrix_complex_long_double::ispos ( ) const

inline

C++ version of gsl_matrix_complex_long_double_ispos().

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

Definition at line 1219 of file matrix_complex_long_double.hpp.

References get().

◆ memcpy()

int gsl::matrix_complex_long_double::memcpy ( matrix_complex_long_double const & src )

inline

C++ version of gsl_matrix_complex_long_double_memcpy().

Parameters

src	source matrix_complex_long_double

Returns: error code on failure

Definition at line 1185 of file matrix_complex_long_double.hpp.

References get().

◆ mul_elements()

int gsl::matrix_complex_long_double::mul_elements ( matrix_complex_long_double const & b )

inline

C++ version of gsl_matrix_complex_long_double_mul_elements().

Multiply matrices elementwise.

Parameters

b	Another matrix_complex_long_double

Returns: error code on failure

Definition at line 1376 of file matrix_complex_long_double.hpp.

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

◆ operator bool()

gsl::matrix_complex_long_double::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

Returns: true or false according as this contains a pointer to a gsl_matrix_complex_long_double

Definition at line 1161 of file matrix_complex_long_double.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

matrix_complex_long_double & gsl::matrix_complex_long_double::operator= ( matrix_complex_long_double && v )

inline

Move operator.

Parameters

v	The matrix_complex_long_double to move.

Returns: A reference to this.

Definition at line 205 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ operator=() [2/2]

matrix_complex_long_double & gsl::matrix_complex_long_double::operator= ( matrix_complex_long_double const & v )

inline

The assignment operator.

This makes a shared copy.

Parameters

v	The matrix_complex_long_double to copy

Definition at line 148 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and count.

◆ operator[]() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::operator[] ( size_t const i )

inline

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

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

Parameters

i	The index of the row

Returns: A vector_complex_long_double representing a row

Definition at line 1454 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAILED, and gsl::vector_complex_long_double::wrap_gsl_vector_complex_long_double_without_ownership().

◆ operator[]() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::operator[] ( size_t const i ) const

inline

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

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

Parameters

i	The index of the row

Returns: A vector_complex_long_double representing a row

Definition at line 1472 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAILED, and gsl::vector_complex_long_double::wrap_gsl_vector_complex_long_double_without_ownership().

◆ permute()

int gsl::matrix_complex_long_double::permute ( permutation & p )

inline

Permute the columns of this by permutation p.

Parameters

p	The permutation

Returns: Error code on failure

Definition at line 1489 of file matrix_complex_long_double.hpp.

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

◆ ptr()

complex_long_double_ptr gsl::matrix_complex_long_double::ptr	(	size_t const	i,
		size_t const	j
	)

inline

C++ version of gsl_matrix_complex_long_double_ptr().

Parameters

i	index of row
j	index of column

Returns: pointer to element

Definition at line 1250 of file matrix_complex_long_double.hpp.

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

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

◆ rbegin() [1/2]

reverse_iterator gsl::matrix_complex_long_double::rbegin ( )

inline

Get iterator pointing to first vector_complex_long_double element.

Returns: iterator pointing to first vector_complex_long_double element

Definition at line 639 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and size1().

◆ rbegin() [2/2]

const_reverse_iterator gsl::matrix_complex_long_double::rbegin ( ) const

inline

Get iterator pointing to first vector_complex_long_double element.

Returns: iterator pointing to first vector_complex_long_double element

Definition at line 647 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and size1().

◆ rend() [1/2]

reverse_iterator gsl::matrix_complex_long_double::rend ( )

inline

Get iterator pointing beyond last vector_complex_long_double element.

Returns: iterator pointing beyond last vector_complex_long_double element

Definition at line 656 of file matrix_complex_long_double.hpp.

◆ rend() [2/2]

const_reverse_iterator gsl::matrix_complex_long_double::rend ( ) const

inline

Get iterator pointing beyond last vector_complex_long_double element.

Returns: iterator pointing beyond last vector_complex_long_double element

Definition at line 663 of file matrix_complex_long_double.hpp.

◆ reset()

void gsl::matrix_complex_long_double::reset ( )

inline

Stop sharing ownership of the shared pointer.

Definition at line 190 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ row() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::row ( size_t const i )

inline

C++ version of gsl_matrix_complex_long_double_row().

Parameters

i	A row index

Returns: A row as a vector_complex_long_double

Definition at line 726 of file matrix_complex_long_double.hpp.

References get().

Referenced by matrix_complex_long_double().

◆ row() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::row ( size_t const i ) const

inline

Another C++ version of gsl_matrix_complex_long_double_const_row().

Parameters

i	A row index

Returns: A row as a vector_complex_long_double

Definition at line 1001 of file matrix_complex_long_double.hpp.

References get().

◆ scale()

int gsl::matrix_complex_long_double::scale ( complex_long_double const x )

inline

C++ version of gsl_matrix_complex_long_double_scale().

Parameters

x	constant to multiply this by

Returns: error code on failure

Definition at line 1203 of file matrix_complex_long_double.hpp.

References get().

◆ scale_columns()

int gsl::matrix_complex_long_double::scale_columns ( vector_complex_long_double const & x )

inline

C++ version of gsl_matrix_complex_long_double_scale_columns().

Parameters

x A scalar

Returns: Error code on failure

Definition at line 1405 of file matrix_complex_long_double.hpp.

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

◆ scale_rows()

int gsl::matrix_complex_long_double::scale_rows ( vector_complex_long_double const & x )

inline

C++ version of gsl_matrix_complex_long_double_scale_rows().

Parameters

x A scalar

Returns: Error code on failure

Definition at line 1398 of file matrix_complex_long_double.hpp.

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

◆ set()

void gsl::matrix_complex_long_double::set	(	size_t const	i,
		size_t const	j,
		complex_long_double	x
	)

inline

C++ version of gsl_matrix_complex_long_double_set().

Parameters

i	index of row
j	index of column
x	new value for element

Definition at line 1243 of file matrix_complex_long_double.hpp.

References get().

Referenced by matrix_complex_long_double().

◆ set_all()

void gsl::matrix_complex_long_double::set_all ( complex_long_double x )

inline

C++ version of gsl_matrix_complex_long_double_set_all().

Parameters

x	The value to which all elements are set

Definition at line 1179 of file matrix_complex_long_double.hpp.

References get().

◆ set_col()

int gsl::matrix_complex_long_double::set_col	(	size_t const	j,
		vector_complex_long_double const &	v
	)

inline

C++ version of gsl_matrix_complex_long_double_set_col().

Parameters

j	The index of the column
v	A vector_complex_long_double

Returns: error code on failure

Definition at line 1444 of file matrix_complex_long_double.hpp.

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

◆ set_identity()

void gsl::matrix_complex_long_double::set_identity ( )

inline

C++ version of gsl_matrix_complex_long_double_set_identity().

Definition at line 1334 of file matrix_complex_long_double.hpp.

References get().

◆ set_row()

int gsl::matrix_complex_long_double::set_row	(	size_t const	i,
		vector_complex_long_double const &	v
	)

inline

C++ version of gsl_matrix_complex_long_double_set_row().

Parameters

i	The index of the row
v	A vector_complex_long_double

Returns: error code on failure

Definition at line 1436 of file matrix_complex_long_double.hpp.

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

◆ set_zero()

void gsl::matrix_complex_long_double::set_zero ( )

inline

C++ version of gsl_matrix_complex_long_double_set_zero().

Definition at line 1174 of file matrix_complex_long_double.hpp.

References get().

◆ size1()

size_t gsl::matrix_complex_long_double::size1 ( ) const

inline

The number of rows of the matrix_complex_long_double.

Returns: The number of rows of the matrix_complex_long_double

Definition at line 672 of file matrix_complex_long_double.hpp.

References ccgsl_pointer.

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

◆ size2()

size_t gsl::matrix_complex_long_double::size2 ( ) const

inline

The number of columns of the matrix_complex_long_double.

Returns: The number of columns of the matrix_complex_long_double

Definition at line 677 of file matrix_complex_long_double.hpp.

References ccgsl_pointer.

Referenced by clone().

◆ sub()

int gsl::matrix_complex_long_double::sub ( matrix_complex_long_double const & b )

inline

C++ version of gsl_matrix_complex_long_double_sub().

Parameters

b	matrix_complex_long_double to subtract from this

Returns: error code on failure

Definition at line 1197 of file matrix_complex_long_double.hpp.

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

◆ subcolumn() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::subcolumn	(	size_t const	j,
		size_t const	offset,
		size_t const	n
	)

inline

C++ version of gsl_matrix_complex_long_double_subcolumn().

Parameters

j	A column index
offset	A row offset
n	The number of elements

Returns: A subcolumn as a vector_complex_long_double

Definition at line 789 of file matrix_complex_long_double.hpp.

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

◆ subcolumn() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::subcolumn	(	size_t const	j,
		size_t const	offset,
		size_t const	n
	)		const

inline

Another C++ version of gsl_matrix_complex_long_double_const_subcolumn().

Parameters

j	A column index
offset	A row offset
n	The number of elements

Returns: A subcolumn as a vector_complex_long_double

Definition at line 1064 of file matrix_complex_long_double.hpp.

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

◆ subdiagonal() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::subdiagonal ( size_t const k )

inline

C++ version of gsl_matrix_complex_long_double_subdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_complex_long_double

Definition at line 755 of file matrix_complex_long_double.hpp.

References get().

◆ subdiagonal() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::subdiagonal ( size_t const k ) const

inline

Another C++ version of gsl_matrix_complex_long_double_const_subdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_complex_long_double

Definition at line 1030 of file matrix_complex_long_double.hpp.

References get().

◆ submatrix() [1/2]

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

inline

C++ version of gsl_matrix_complex_long_double_submatrix().

Parameters

i	Index in `this` of first row of submatrix
j	Index in `this` of first column of submatrix
n1	Number of rows of submatrix
n2	Number of columns of submatrix

Returns: The submatrix

Definition at line 716 of file matrix_complex_long_double.hpp.

References get(), and matrix_complex_long_double().

◆ submatrix() [2/2]

matrix_complex_long_double const gsl::matrix_complex_long_double::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_long_double_const_submatrix().

Parameters

i	Index in `this` of first row of submatrix
j	Index in `this` of first column of submatrix
n1	Number of rows of submatrix
n2	Number of columns of submatrix

Returns: The submatrix

Definition at line 991 of file matrix_complex_long_double.hpp.

References get(), and matrix_complex_long_double().

◆ subrow() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::subrow	(	size_t const	i,
		size_t const	offset,
		size_t const	n
	)

inline

C++ version of gsl_matrix_complex_long_double_subrow().

Parameters

i	A row index
offset	A column offset
n	The number of elements

Returns: A subrow as a vector_complex_long_double

Definition at line 777 of file matrix_complex_long_double.hpp.

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

◆ subrow() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::subrow	(	size_t const	i,
		size_t const	offset,
		size_t const	n
	)		const

inline

Another C++ version of gsl_matrix_complex_long_double_const_subrow().

Parameters

i	A row index
offset	A column offset
n	The number of elements

Returns: A subrow as a vector_complex_long_double

Definition at line 1052 of file matrix_complex_long_double.hpp.

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

◆ superdiagonal() [1/2]

vector_complex_long_double gsl::matrix_complex_long_double::superdiagonal ( size_t const k )

inline

C++ version of gsl_matrix_complex_long_double_superdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_complex_long_double

Definition at line 765 of file matrix_complex_long_double.hpp.

References get().

◆ superdiagonal() [2/2]

vector_complex_long_double const gsl::matrix_complex_long_double::superdiagonal ( size_t const k ) const

inline

Another C++ version of gsl_matrix_complex_long_double_const_superdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_complex_long_double

Definition at line 1040 of file matrix_complex_long_double.hpp.

References get().

◆ swap()

void gsl::matrix_complex_long_double::swap ( matrix_complex_long_double & m )

inline

Swap two matrix_complex_long_double objects.

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

Parameters

m	The matrix_complex_long_double to swap with `this`.

Definition at line 683 of file matrix_complex_long_double.hpp.

References ccgsl_pointer, and count.

◆ swap_columns()

int gsl::matrix_complex_long_double::swap_columns	(	size_t const	i,
		size_t const	j
	)

inline

C++ version of gsl_matrix_complex_long_double_swap_columns().

Parameters

i	Index of first column
j	Index of second column

Returns: error code on failure

Definition at line 1348 of file matrix_complex_long_double.hpp.

References get().

◆ swap_rowcol()

int gsl::matrix_complex_long_double::swap_rowcol	(	size_t const	i,
		size_t const	j
	)

inline

C++ version of gsl_matrix_complex_long_double_swap_rowcol().

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

Parameters

i	index of row
j	index of column

Returns: error code on failure

Definition at line 1357 of file matrix_complex_long_double.hpp.

References get().

◆ swap_rows()

int gsl::matrix_complex_long_double::swap_rows	(	size_t const	i,
		size_t const	j
	)

inline

C++ version of gsl_matrix_complex_long_double_swap_rows().

Parameters

i	Index of first row
j	Index of second row

Returns: error code on failure

Definition at line 1341 of file matrix_complex_long_double.hpp.

References get().

◆ transpose()

int gsl::matrix_complex_long_double::transpose ( )

inline

C++ version of gsl_matrix_complex_long_double_transpose().

Returns: error code on failure.

Definition at line 1362 of file matrix_complex_long_double.hpp.

References get().

◆ transpose_memcpy()

int gsl::matrix_complex_long_double::transpose_memcpy ( matrix_complex_long_double const & src )

inline

C++ version of gsl_matrix_complex_long_double_transpose_memcpy().

Parameters

src	matrix_complex_long_double whose transpose it to be copied to `this`

Returns: error code on failure

Definition at line 1368 of file matrix_complex_long_double.hpp.

References get().

◆ transpose_tricpy()

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

inline

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

Parameters

Uplo	Upper or lower triangle: CblasUpper or CBlasLower
Diag	Diagonal type
src	The matrix to copy from

Definition at line 703 of file matrix_complex_long_double.hpp.

References get().

◆ tricpy()

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

inline

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

Parameters

Uplo	Upper or lower triangle: CblasUpper or CBlasLower
Diag	Diagonal type
src	The matrix to copy from

Definition at line 693 of file matrix_complex_long_double.hpp.

References get().

◆ unique()

bool gsl::matrix_complex_long_double::unique ( ) const

inline

Find if this is the only object sharing the gsl_matrix_complex_long_double.

Returns: true or falses according as this is the only matrix_complex_long_double object sharing the gsl_matrix_complex_long_double

Definition at line 1147 of file matrix_complex_long_double.hpp.

References count.

◆ use_count()

size_t gsl::matrix_complex_long_double::use_count ( ) const

inline

Find how many matrix_complex_long_double objects share this pointer.

Returns: the number of matrix_complex_long_double objects that share this pointer

Definition at line 1152 of file matrix_complex_long_double.hpp.

References count.

◆ view_array() [1/2]

static matrix_complex_long_double gsl::matrix_complex_long_double::view_array	(	long double *	base,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_view_array().

Parameters

base	An array of type long double
n1	The number of rows
n2	The number of columns

Returns: A matrix_complex_long_double

Definition at line 801 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ view_array() [2/2]

static matrix_complex_long_double const gsl::matrix_complex_long_double::view_array	(	long double const *	base,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

Another C++ version of gsl_matrix_complex_long_double_const_view_array().

Parameters

base	An array of type long double
n1	The number of rows
n2	The number of columns

Returns: A matrix_complex_long_double

Definition at line 1076 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ view_array_with_tda() [1/2]

static matrix_complex_long_double gsl::matrix_complex_long_double::view_array_with_tda	(	long double *	base,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_view_array_with_tda().

Parameters

base	An array of type long double
n1	The number of rows
n2	The number of columns
tda	The number of columns in memory

Returns: A matrix_complex_long_double

Definition at line 814 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ view_array_with_tda() [2/2]

static matrix_complex_long_double const gsl::matrix_complex_long_double::view_array_with_tda	(	long double const *	base,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

Another C++ version of gsl_matrix_complex_long_double_const_view_array_with_tda().

Parameters

base	An array of type long double
n1	The number of rows
n2	The number of columns
tda	The number of columns in memory

Returns: A matrix_complex_long_double

Definition at line 1090 of file matrix_complex_long_double.hpp.

References matrix_complex_long_double().

◆ view_vector() [1/2]

static matrix_complex_long_double gsl::matrix_complex_long_double::view_vector	(	vector_complex_long_double &	v,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_view_vector().

Parameters

v	A vector_complex_long_double
n1	The number of rows
n2	The number of columns

Returns: A matrix_complex_long_double

Definition at line 826 of file matrix_complex_long_double.hpp.

References gsl::vector_complex_long_double::get(), and matrix_complex_long_double().

◆ view_vector() [2/2]

static matrix_complex_long_double const gsl::matrix_complex_long_double::view_vector	(	vector_complex_long_double const &	v,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

Another C++ version of gsl_matrix_complex_long_double_const_view_vector().

Parameters

v	A vector_complex_long_double
n1	The number of rows
n2	The number of columns

Returns: A matrix_complex_long_double

Definition at line 1102 of file matrix_complex_long_double.hpp.

References gsl::vector_complex_long_double::get(), and matrix_complex_long_double().

◆ view_vector_with_tda() [1/2]

static matrix_complex_long_double gsl::matrix_complex_long_double::view_vector_with_tda	(	vector_complex_long_double &	v,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_complex_long_double_view_vector_with_tda().

Parameters

v	A vector_complex_long_double
n1	The number of rows
n2	The number of columns
tda	The number of columns in memory

Returns: A matrix_complex_long_double

Definition at line 839 of file matrix_complex_long_double.hpp.

References gsl::vector_complex_long_double::get(), and matrix_complex_long_double().

◆ view_vector_with_tda() [2/2]

static matrix_complex_long_double const gsl::matrix_complex_long_double::view_vector_with_tda	(	vector_complex_long_double const &	v,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

Another C++ version of gsl_matrix_complex_long_double_const_view_vector_with_tda().

Parameters

v	A vector_complex_long_double
n1	The number of rows
n2	The number of columns
tda	The number of columns in memory

Returns: A matrix_complex_long_double

Definition at line 1116 of file matrix_complex_long_double.hpp.

References gsl::vector_complex_long_double::get(), and matrix_complex_long_double().

Member Data Documentation

◆ ccgsl_pointer

gsl_matrix_complex_long_double* gsl::matrix_complex_long_double::ccgsl_pointer

private

The shared pointer.

Definition at line 1125 of file matrix_complex_long_double.hpp.

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

◆ count

size_t* gsl::matrix_complex_long_double::count

private

The shared reference count.

Definition at line 1129 of file matrix_complex_long_double.hpp.

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

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

matrix_complex_long_double.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ size_type

Constructor & Destructor Documentation

◆ matrix_complex_long_double() [1/8]

◆ matrix_complex_long_double() [2/8]

◆ matrix_complex_long_double() [3/8]

◆ matrix_complex_long_double() [4/8]

◆ matrix_complex_long_double() [5/8]

◆ ~matrix_complex_long_double()

◆ matrix_complex_long_double() [6/8]

◆ matrix_complex_long_double() [7/8]

◆ matrix_complex_long_double() [8/8]

Member Function Documentation

◆ add()

◆ add_constant()

◆ add_diagonal()

◆ begin() [1/2]

◆ begin() [2/2]

◆ calloc()

◆ clone()

◆ column() [1/2]

◆ column() [2/2]

◆ conjtrans_memcpy()

◆ const_column()

◆ const_diagonal()

◆ const_ptr()

◆ const_row()

◆ const_subcolumn()

◆ const_subdiagonal()

◆ const_submatrix()

◆ const_subrow()

◆ const_superdiagonal()

◆ const_view_array()

◆ const_view_array_with_tda()

◆ const_view_vector()

◆ const_view_vector_with_tda()

◆ diagonal() [1/2]

◆ diagonal() [2/2]

◆ div_elements()

◆ end() [1/2]

◆ end() [2/2]

◆ fprintf()

◆ fread()

◆ fscanf()

◆ fwrite()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ get_col()

◆ get_row()

◆ isneg()

◆ isnonneg()

◆ isnull()

◆ ispos()

◆ memcpy()

◆ mul_elements()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ permute()

◆ ptr()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ reset()

◆ row() [1/2]

◆ row() [2/2]