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

#include <matrix_char.hpp>

Collaboration diagram for gsl::matrix_char:

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

	matrix_char (size_t const n1, size_t const n2)
	This constructor creates a new matrix_char with n1 rows and n2 columns. More...

	matrix_char (gsl_matrix_char *v)
	Could construct from a gsl_matrix_char. More...

	matrix_char (std::initializer_list< std::initializer_list< char > > initializer_list)
	Could construct from a std::initializer_list in C++11. More...

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

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

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

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

void	wrap_gsl_matrix_char_without_ownership (gsl_matrix_char *v)
	This function is intended mainly for internal use. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

char *	data ()
	Give access to the data block_char. More...

char const *	data () const
	Give access to the data block_char. More...

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

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

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

vector_char	row (size_t const i)
	C++ version of gsl_matrix_char_row(). More...

vector_char	column (size_t const j)
	C++ version of gsl_matrix_char_column(). More...

vector_char	diagonal ()
	C++ version of gsl_matrix_char_diagonal(). More...

vector_char	subdiagonal (size_t const k)
	C++ version of gsl_matrix_char_subdiagonal(). More...

vector_char	superdiagonal (size_t const k)
	C++ version of gsl_matrix_char_superdiagonal(). More...

vector_char	subrow (size_t const i, size_t const offset, size_t const n)
	C++ version of gsl_matrix_char_subrow(). More...

vector_char	subcolumn (size_t const j, size_t const offset, size_t const n)
	C++ version of gsl_matrix_char_subcolumn(). More...

matrix_char 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_char_const_submatrix(). More...

vector_char const	const_row (size_t const i) const
	C++ version of gsl_matrix_char_const_row(). More...

vector_char const	const_column (size_t const j) const
	C++ version of gsl_matrix_char_const_column(). More...

vector_char const	const_diagonal () const
	C++ version of gsl_matrix_char_const_diagonal(). More...

vector_char const	const_subdiagonal (size_t const k) const
	C++ version of gsl_matrix_char_const_subdiagonal(). More...

vector_char const	const_superdiagonal (size_t const k) const
	C++ version of gsl_matrix_char_const_superdiagonal(). More...

vector_char const	const_subrow (size_t const i, size_t const offset, size_t const n) const
	C++ version of gsl_matrix_char_const_subrow(). More...

vector_char const	const_subcolumn (size_t const j, size_t const offset, size_t const n) const
	C++ version of gsl_matrix_char_const_subcolumn(). More...

matrix_char 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_char_const_submatrix(). More...

vector_char const	row (size_t const i) const
	Another C++ version of gsl_matrix_char_const_row(). More...

vector_char const	column (size_t const j) const
	Another C++ version of gsl_matrix_char_const_column(). More...

vector_char const	diagonal () const
	Another C++ version of gsl_matrix_char_const_diagonal(). More...

vector_char const	subdiagonal (size_t const k) const
	Another C++ version of gsl_matrix_char_const_subdiagonal(). More...

vector_char const	superdiagonal (size_t const k) const
	Another C++ version of gsl_matrix_char_const_superdiagonal(). More...

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

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

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

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

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

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

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

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

void	set_all (char x)
	C++ version of gsl_matrix_char_set_all(). More...

int	memcpy (matrix_char const &src)
	C++ version of gsl_matrix_char_memcpy(). More...

char	max () const
	C++ version of gsl_matrix_char_max(). More...

char	min () const
	C++ version of gsl_matrix_char_min(). More...

void	minmax (char min_out, char max_out) const
	C++ version of gsl_matrix_char_minmax(). More...

void	minmax (char &min_out, char &max_out) const
	C++ version of gsl_matrix_char_minmax(). More...

int	add (matrix_char const &b)
	C++ version of gsl_matrix_char_add(). More...

int	sub (matrix_char const &b)
	C++ version of gsl_matrix_char_sub(). More...

int	scale (char const x)
	C++ version of gsl_matrix_char_scale(). More...

int	add_constant (char const x)
	C++ version of gsl_matrix_char_add_constant(). More...

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

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

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

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

char	get (size_t const i, size_t const j) const
	C++ version of gsl_matrix_char_get(). More...

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

char *	ptr (size_t const i, size_t const j)
	C++ version of gsl_matrix_char_ptr(). More...

char const *	const_ptr (size_t const i, size_t const j) const
	C++ version of gsl_matrix_char_const_ptr(). More...

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

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

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

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

	matrix_char (block_char &b, size_t const offset, size_t const n1, size_t const n2, size_t const d2)
	C++ version of gsl_matrix_char_alloc_from_block(). More...

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

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

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

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

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

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

int	transpose_memcpy (matrix_char const &src)
	C++ version of gsl_matrix_char_transpose_memcpy(). More...

void	max_index (size_t &imax, size_t &jmax) const
	C++ version of gsl_matrix_char_max_index(). More...

void	min_index (size_t &imin, size_t &jmin) const
	C++ version of gsl_matrix_char_min_index(). More...

void	minmax_index (size_t &imin, size_t &jmin, size_t &imax, size_t &jmax) const
	C++ version of gsl_matrix_char_minmax_index(). More...

int	mul_elements (matrix_char const &b)
	C++ version of gsl_matrix_char_mul_elements(). More...

int	div_elements (matrix_char const &b)
	C++ version of gsl_matrix_char_div_elements(). More...

char	norm1 () const
	C++ version of gsl_matrix_char_norm1(). More...

int	scale_rows (vector_char const &x)
	C++ version of gsl_matrix_char_scale_rows(). More...

int	scale_columns (vector_char const &x)
	C++ version of gsl_matrix_char_scale_columns(). More...

int	add_diagonal (char const x)
	C++ version of gsl_matrix_char_add_diagonal(). More...

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

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

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

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

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

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

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

Static Public Member Functions
static matrix_char	view_array (char *base, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_char_view_array(). More...

static matrix_char	view_array_with_tda (char *base, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_char_view_array_with_tda(). More...

static matrix_char	view_vector (vector_char &v, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_char_view_vector(). More...

static matrix_char	view_vector_with_tda (vector_char &v, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_char_view_vector_with_tda(). More...

static matrix_char const	const_view_array (char const *base, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_char_const_view_array(). More...

static matrix_char const	const_view_array_with_tda (char const *base, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_char_const_view_array_with_tda(). More...

static matrix_char const	const_view_vector (vector_char const &v, size_t const n1, size_t const n2)
	C++ version of gsl_matrix_char_const_view_vector(). More...

static matrix_char const	const_view_vector_with_tda (vector_char const &v, size_t const n1, size_t const n2, size_t const tda)
	C++ version of gsl_matrix_char_const_view_vector_with_tda(). More...

static matrix_char const	view_array (char const *base, size_t const n1, size_t const n2)
	Another C++ version of gsl_matrix_char_const_view_array(). More...

static matrix_char const	view_array_with_tda (char const *base, size_t const n1, size_t const n2, size_t const tda)
	Another C++ version of gsl_matrix_char_const_view_array_with_tda(). More...

static matrix_char const	view_vector (vector_char const &v, size_t const n1, size_t const n2)
	Another C++ version of gsl_matrix_char_const_view_vector(). More...

static matrix_char const	view_vector_with_tda (vector_char const &v, size_t const n1, size_t const n2, size_t const tda)
	Another C++ version of gsl_matrix_char_const_view_vector_with_tda(). More...

static matrix_char	calloc (size_t const n1, size_t const n2)
	C++ version of gsl_matrix_char_calloc(). More...

Private Attributes
bool	owns_data
	Used to allow a vector that does not own its data. More...

gsl_matrix_char *	ccgsl_pointer
	The shared pointer. More...

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

Detailed Description

This class handles matrix_char objects as shared handles.

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

Note that matrix_char_views are implemented as matrix_char objects here.

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

for( auto row : matrix_char ){ ... }

gsl::matrix_char

This class handles matrix_char objects as shared handles.

Definition: matrix_char.hpp:58

gsl::matrix_char::row

vector_char row(size_t const i)

C++ version of gsl_matrix_char_row().

Definition: matrix_char.hpp:776

Otherwise,

for( matrix_char::iterator i = matrix_char.begin(); i != matrix_char.end(); ++i ){
  vector_char 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_char.

Definition at line 58 of file matrix_char.hpp.

Member Typedef Documentation

◆ const_iterator

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

The const_iterator type.

Definition at line 609 of file matrix_char.hpp.

◆ const_reverse_iterator

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

The const_reverse_t type.

Definition at line 617 of file matrix_char.hpp.

◆ iterator

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

The iterator type.

Definition at line 613 of file matrix_char.hpp.

◆ reverse_iterator

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

The reverse_iterator type.

Definition at line 621 of file matrix_char.hpp.

◆ size_type

typedef size_t gsl::matrix_char::size_type

A container must have a size_type.

Definition at line 625 of file matrix_char.hpp.

Constructor & Destructor Documentation

◆ matrix_char() [1/8]

gsl::matrix_char::matrix_char ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 63 of file matrix_char.hpp.

References ccgsl_pointer, count, and owns_data.

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_char() [2/8]

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

inlineexplicit

This constructor creates a new matrix_char with n1 rows and n2 columns.

Parameters

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

Definition at line 75 of file matrix_char.hpp.

References ccgsl_pointer, and count.

◆ matrix_char() [3/8]

gsl::matrix_char::matrix_char ( gsl_matrix_char * v )

inlineexplicit

Could construct from a gsl_matrix_char.

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

Parameters

v	The matrix_char

Definition at line 93 of file matrix_char.hpp.

References ccgsl_pointer, and count.

◆ matrix_char() [4/8]

gsl::matrix_char::matrix_char ( std::initializer_list< std::initializer_list< char > > initializer_list )

inline

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

Parameters

initializer_list The initializer_list.

Definition at line 104 of file matrix_char.hpp.

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

◆ matrix_char() [5/8]

gsl::matrix_char::matrix_char ( matrix_char const & v )

inline

The copy constructor.

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

Parameters

v	The matrix_char to copy.

Definition at line 137 of file matrix_char.hpp.

References count.

◆ ~matrix_char()

gsl::matrix_char::~matrix_char ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 177 of file matrix_char.hpp.

References ccgsl_pointer, count, and owns_data.

◆ matrix_char() [6/8]

gsl::matrix_char::matrix_char ( matrix_char && v )

inline

Move constructor.

Parameters

v	The matrix_char to move.

Definition at line 219 of file matrix_char.hpp.

References count.

◆ matrix_char() [7/8]

gsl::matrix_char::matrix_char	(	block_char &	b,
		size_t const	offset,
		size_t const	n1,
		size_t const	n2,
		size_t const	d2
	)

inline

C++ version of gsl_matrix_char_alloc_from_block().

Parameters

b	The block_char
offset	The offset within the block_char
n1	The number of rows in the matrix_char
n2	The number of columns in the matrix_char
d2	undocumented

Definition at line 1371 of file matrix_char.hpp.

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

◆ matrix_char() [8/8]

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

inline

C++ version of gsl_matrix_char_alloc_from_matrix().

Parameters

m	The matrix_char
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_char
n2	The number of columns in the matrix_char

Definition at line 1389 of file matrix_char.hpp.

References ccgsl_pointer, count, and get().

Member Function Documentation

◆ add()

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

inline

C++ version of gsl_matrix_char_add().

Parameters

b	matrix_char to add to this

Returns: error code on failure

Definition at line 1269 of file matrix_char.hpp.

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

◆ add_constant()

int gsl::matrix_char::add_constant ( char const x )

inline

C++ version of gsl_matrix_char_add_constant().

Parameters

x	constant to add to each element of this

Returns: error code on failure

Definition at line 1287 of file matrix_char.hpp.

References get().

◆ add_diagonal()

int gsl::matrix_char::add_diagonal ( char const x )

inline

C++ version of gsl_matrix_char_add_diagonal().

Parameters

x	A constant

Returns: error code on failure

Definition at line 1527 of file matrix_char.hpp.

References get().

◆ begin() [1/2]

iterator gsl::matrix_char::begin ( )

inline

Get iterator pointing to first vector_char element.

Returns: iterator pointing to first vector_char element

Definition at line 631 of file matrix_char.hpp.

◆ begin() [2/2]

const_iterator gsl::matrix_char::begin ( ) const

inline

Get iterator pointing to first vector_char element.

Returns: iterator pointing to first vector_char element

Definition at line 638 of file matrix_char.hpp.

◆ calloc()

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

inlinestatic

C++ version of gsl_matrix_char_calloc().

This constructs a matrix_char object with entries initialised to zero.

Parameters

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

Returns: A matrix_char initialised to zero

Definition at line 1224 of file matrix_char.hpp.

References matrix_char().

◆ clone()

matrix_char gsl::matrix_char::clone ( ) const

inline

The clone function.

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

Returns: a new copy of this.

Definition at line 166 of file matrix_char.hpp.

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

◆ column() [1/2]

vector_char gsl::matrix_char::column ( size_t const j )

inline

C++ version of gsl_matrix_char_column().

Parameters

j	A column index

Returns: A column as a vector_char

Definition at line 786 of file matrix_char.hpp.

References get().

◆ column() [2/2]

vector_char const gsl::matrix_char::column ( size_t const j ) const

inline

Another C++ version of gsl_matrix_char_const_column().

Parameters

j	A column index

Returns: A column as a vector_char

Definition at line 1009 of file matrix_char.hpp.

References get().

◆ const_column()

vector_char const gsl::matrix_char::const_column ( size_t const j ) const

inline

C++ version of gsl_matrix_char_const_column().

Parameters

j	A column index

Returns: A column as a vector_char

Definition at line 923 of file matrix_char.hpp.

References get().

◆ const_diagonal()

vector_char const gsl::matrix_char::const_diagonal ( ) const

inline

C++ version of gsl_matrix_char_const_diagonal().

Returns: The principal diagonal as a vector_char

Definition at line 932 of file matrix_char.hpp.

References get().

◆ const_ptr()

char const * gsl::matrix_char::const_ptr	(	size_t const	i,
		size_t const	j
	)		const

inline

C++ version of gsl_matrix_char_const_ptr().

Parameters

i	index of row
j	index of column

Returns: pointer to element

Definition at line 1335 of file matrix_char.hpp.

References get().

◆ const_row()

vector_char const gsl::matrix_char::const_row ( size_t const i ) const

inline

C++ version of gsl_matrix_char_const_row().

Parameters

i	A row index

Returns: A row as a vector_char

Definition at line 913 of file matrix_char.hpp.

References get().

◆ const_subcolumn()

vector_char const gsl::matrix_char::const_subcolumn	(	size_t const	j,
		size_t const	offset,
		size_t const	n
	)		const

inline

C++ version of gsl_matrix_char_const_subcolumn().

Parameters

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

Returns: A subcolumn as a vector_char

Definition at line 976 of file matrix_char.hpp.

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

◆ const_subdiagonal()

vector_char const gsl::matrix_char::const_subdiagonal ( size_t const k ) const

inline

C++ version of gsl_matrix_char_const_subdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_char

Definition at line 942 of file matrix_char.hpp.

References get().

◆ const_submatrix()

matrix_char const gsl::matrix_char::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_char_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 903 of file matrix_char.hpp.

References get(), and matrix_char().

◆ const_subrow()

vector_char const gsl::matrix_char::const_subrow	(	size_t const	i,
		size_t const	offset,
		size_t const	n
	)		const

inline

C++ version of gsl_matrix_char_const_subrow().

Parameters

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

Returns: A subrow as a vector_char

Definition at line 964 of file matrix_char.hpp.

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

◆ const_superdiagonal()

vector_char const gsl::matrix_char::const_superdiagonal ( size_t const k ) const

inline

C++ version of gsl_matrix_char_const_superdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_char

Definition at line 952 of file matrix_char.hpp.

References get().

◆ const_view_array()

static matrix_char const gsl::matrix_char::const_view_array	(	char const *	base,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_char_const_view_array().

Parameters

base	An array of type char
n1	The number of rows
n2	The number of columns

Returns: A matrix_char

Definition at line 1074 of file matrix_char.hpp.

References matrix_char().

◆ const_view_array_with_tda()

static matrix_char const gsl::matrix_char::const_view_array_with_tda	(	char const *	base,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_char_const_view_array_with_tda().

Parameters

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

Returns: A matrix_char

Definition at line 1088 of file matrix_char.hpp.

References matrix_char().

◆ const_view_vector()

static matrix_char const gsl::matrix_char::const_view_vector	(	vector_char const &	v,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_char_const_view_vector().

Parameters

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

Returns: A matrix_char

Definition at line 1100 of file matrix_char.hpp.

References gsl::vector_char::get(), and matrix_char().

◆ const_view_vector_with_tda()

static matrix_char const gsl::matrix_char::const_view_vector_with_tda	(	vector_char const &	v,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_char_const_view_vector_with_tda().

Parameters

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

Returns: A matrix_char

Definition at line 1114 of file matrix_char.hpp.

References gsl::vector_char::get(), and matrix_char().

◆ data() [1/2]

char * gsl::matrix_char::data ( )

inline

Give access to the data block_char.

The data() and size() functions mimic the functions of std::array<T> and std::vector<T>. This function can throw an exception or produce a GSL error if the matrix_char size2 and tda are not equal. However, new matrix_char objects are always initialised to have tda and size2 equal.

Returns: The data block_char.

Definition at line 709 of file matrix_char.hpp.

References ccgsl_pointer.

◆ data() [2/2]

char const * gsl::matrix_char::data ( ) const

inline

Give access to the data block_char.

The data() and size() functions mimic the functions of std::array<T> and std::vector<T>. This function can throw an exception or produce a GSL error if the matrix_char size1 and tda are not equal. However, new matrix_char objects are always initialised to have tda and size2 equal.

Returns: The data block_char.

Definition at line 723 of file matrix_char.hpp.

References ccgsl_pointer.

◆ diagonal() [1/2]

vector_char gsl::matrix_char::diagonal ( )

inline

C++ version of gsl_matrix_char_diagonal().

Returns: The principal diagonal as a vector_char

Definition at line 796 of file matrix_char.hpp.

References get().

◆ diagonal() [2/2]

vector_char const gsl::matrix_char::diagonal ( ) const

inline

Another C++ version of gsl_matrix_char_const_diagonal().

Returns: The principal diagonal as a vector_char

Definition at line 1018 of file matrix_char.hpp.

References get().

◆ div_elements()

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

inline

C++ version of gsl_matrix_char_div_elements().

Divide each element of this by the corrsponding element of b

Parameters

b	Another matrix_char

Returns: error code on failure

Definition at line 1500 of file matrix_char.hpp.

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

◆ end() [1/2]

iterator gsl::matrix_char::end ( )

inline

Get iterator pointing beyond last vector_char element.

Returns: iterator pointing beyond last vector_char element

Definition at line 646 of file matrix_char.hpp.

References ccgsl_pointer, and size1().

◆ end() [2/2]

const_iterator gsl::matrix_char::end ( ) const

inline

Get iterator pointing beyond last vector_char element.

Returns: iterator pointing beyond last vector_char element

Definition at line 654 of file matrix_char.hpp.

References ccgsl_pointer, and size1().

◆ fprintf()

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

inline

C++ version of gsl_matrix_char_fprintf().

Parameters

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

Returns: error code on failure

Definition at line 1361 of file matrix_char.hpp.

References get().

◆ fread()

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

inline

C++ version of gsl_matrix_char_fread().

Parameters

stream A C file stream

Returns: error code on failure

Definition at line 1342 of file matrix_char.hpp.

References get().

◆ fscanf()

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

inline

C++ version of gsl_matrix_char_fscanf().

Parameters

stream A C file stream

Returns: error code on failure

Definition at line 1354 of file matrix_char.hpp.

References get().

◆ fwrite()

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

inline

C++ version of gsl_matrix_char_fwrite().

Parameters

stream A C file stream

Returns: error code on failure

Definition at line 1348 of file matrix_char.hpp.

References get().

◆ get() [1/3]

gsl_matrix_char * gsl::matrix_char::get ( )

inline

Get the gsl_matrix_char.

Returns: the gsl_matrix_char

Definition at line 1190 of file matrix_char.hpp.

References ccgsl_pointer.

Referenced by add(), add_constant(), add_diagonal(), clone(), column(), const_column(), const_diagonal(), const_ptr(), const_row(), const_subcolumn(), const_subdiagonal(), const_submatrix(), const_subrow(), const_superdiagonal(), gsl::spmatrix_char::d2sp(), diagonal(), div_elements(), fprintf(), fread(), fscanf(), fwrite(), get_col(), get_row(), isneg(), isnonneg(), isnull(), ispos(), matrix_char(), max(), max_index(), memcpy(), min(), min_index(), minmax(), minmax_index(), mul_elements(), norm1(), permute(), ptr(), row(), scale(), scale_columns(), scale_rows(), set(), set_all(), set_col(), set_identity(), set_row(), set_zero(), gsl::spmatrix_char::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_char const * gsl::matrix_char::get ( ) const

inline

Get the gsl_matrix_char.

Returns: the gsl_matrix_char

Definition at line 1195 of file matrix_char.hpp.

References ccgsl_pointer.

◆ get() [3/3]

char gsl::matrix_char::get	(	size_t const	i,
		size_t const	j
	)		const

inline

C++ version of gsl_matrix_char_get().

Parameters

i	index of row
j	index of column

Returns: value of element

Definition at line 1314 of file matrix_char.hpp.

References get().

Referenced by get().

◆ get_col()

int gsl::matrix_char::get_col	(	vector_char &	v,
		size_t const	j
	)		const

inline

C++ version of gsl_matrix_char_get_col().

Parameters

v	A vector_char
j	The index of the column

Returns: error code on failure

Definition at line 1543 of file matrix_char.hpp.

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

◆ get_row()

int gsl::matrix_char::get_row	(	vector_char &	v,
		size_t const	i
	)		const

inline

C++ version of gsl_matrix_char_get_row().

Parameters

v	A vector_char
i	The index of the row

Returns: error code on failure

Definition at line 1535 of file matrix_char.hpp.

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

◆ isneg()

int gsl::matrix_char::isneg ( ) const

inline

C++ version of gsl_matrix_char_isneg().

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

Definition at line 1302 of file matrix_char.hpp.

References get().

◆ isnonneg()

int gsl::matrix_char::isnonneg ( ) const

inline

C++ version of gsl_matrix_char_isnonneg().

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

Definition at line 1307 of file matrix_char.hpp.

References get().

◆ isnull()

int gsl::matrix_char::isnull ( ) const

inline

C++ version of gsl_matrix_char_isnull().

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

Definition at line 1292 of file matrix_char.hpp.

References get().

◆ ispos()

int gsl::matrix_char::ispos ( ) const

inline

C++ version of gsl_matrix_char_ispos().

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

Definition at line 1297 of file matrix_char.hpp.

References get().

◆ max()

char gsl::matrix_char::max ( ) const

inline

C++ version of gsl_matrix_char_max().

Returns: maximum element of matrix_char

Definition at line 1244 of file matrix_char.hpp.

References get().

◆ max_index()

void gsl::matrix_char::max_index	(	size_t &	imax,
		size_t &	jmax
	)		const

inline

C++ version of gsl_matrix_char_max_index().

Parameters

imax	row index of the first maximum element in the matrix_char
jmax	column index of the first maximum element in the matrix_char

Definition at line 1468 of file matrix_char.hpp.

References get().

◆ memcpy()

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

inline

C++ version of gsl_matrix_char_memcpy().

Parameters

src	source matrix_char

Returns: error code on failure

Definition at line 1239 of file matrix_char.hpp.

References get().

◆ min()

char gsl::matrix_char::min ( ) const

inline

C++ version of gsl_matrix_char_min().

Returns: minimum element of matrix_char

Definition at line 1249 of file matrix_char.hpp.

References get().

◆ min_index()

void gsl::matrix_char::min_index	(	size_t &	imin,
		size_t &	jmin
	)		const

inline

C++ version of gsl_matrix_char_min_index().

Parameters

imin	row index of the first minimum element in the matrix_char
jmin	column index of the first minimum element in the matrix_char

Definition at line 1475 of file matrix_char.hpp.

References get().

◆ minmax() [1/2]

void gsl::matrix_char::minmax	(	char &	min_out,
		char &	max_out
	)		const

inline

C++ version of gsl_matrix_char_minmax().

Parameters

min_out	minimum element of matrix_char
max_out	maximum element of matrix_char

Definition at line 1262 of file matrix_char.hpp.

References get().

◆ minmax() [2/2]

void gsl::matrix_char::minmax	(	char *	min_out,
		char *	max_out
	)		const

inline

C++ version of gsl_matrix_char_minmax().

Parameters

min_out	minimum element of matrix_char
max_out	maximum element of matrix_char

Definition at line 1255 of file matrix_char.hpp.

References get().

◆ minmax_index()

void gsl::matrix_char::minmax_index	(	size_t &	imin,
		size_t &	jmin,
		size_t &	imax,
		size_t &	jmax
	)		const

inline

C++ version of gsl_matrix_char_minmax_index().

Parameters

imin	row index of the first minimum element in the matrix_char
jmin	column index of the first minimum element in the matrix_char
imax	row index of the first maximum element in the matrix_char
jmax	column index of the first maximum element in the matrix_char

Definition at line 1484 of file matrix_char.hpp.

References get().

◆ mul_elements()

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

inline

C++ version of gsl_matrix_char_mul_elements().

Multiply matrices elementwise.

Parameters

b	Another matrix_char

Returns: error code on failure

Definition at line 1492 of file matrix_char.hpp.

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

◆ norm1()

char gsl::matrix_char::norm1 ( ) const

inline

C++ version of gsl_matrix_char_norm1().

Returns: 1-norm of matrix

Definition at line 1506 of file matrix_char.hpp.

References get().

◆ operator bool()

gsl::matrix_char::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

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

Definition at line 1215 of file matrix_char.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

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

inline

Move operator.

Parameters

v	The matrix_char to move.

Returns: A reference to this.

Definition at line 229 of file matrix_char.hpp.

References matrix_char().

◆ operator=() [2/2]

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

inline

The assignment operator.

This makes a shared copy.

Parameters

v	The matrix_char to copy

Definition at line 146 of file matrix_char.hpp.

References ccgsl_pointer, count, and owns_data.

◆ operator[]() [1/2]

vector_char gsl::matrix_char::operator[] ( size_t const i )

inline

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

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

Parameters

i	The index of the row

Returns: A vector_char representing a row

Definition at line 1569 of file matrix_char.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAULT, gsl::exception::GSL_EINVAL, size1(), and gsl::vector_char::wrap_gsl_vector_char_without_ownership().

◆ operator[]() [2/2]

vector_char const gsl::matrix_char::operator[] ( size_t const i ) const

inline

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

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

Parameters

i	The index of the row

Returns: A vector_char representing a row

Definition at line 1603 of file matrix_char.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAULT, and gsl::vector_char::wrap_gsl_vector_char_without_ownership().

◆ permute()

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

inline

Permute the columns of this by permutation p.

Parameters

p	The permutation

Returns: Error code on failure

Definition at line 1620 of file matrix_char.hpp.

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

◆ ptr()

char * gsl::matrix_char::ptr	(	size_t const	i,
		size_t const	j
	)

inline

C++ version of gsl_matrix_char_ptr().

Parameters

i	index of row
j	index of column

Returns: pointer to element

Definition at line 1328 of file matrix_char.hpp.

References get().

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

◆ rbegin() [1/2]

reverse_iterator gsl::matrix_char::rbegin ( )

inline

Get iterator pointing to first vector_char element.

Returns: iterator pointing to first vector_char element

Definition at line 663 of file matrix_char.hpp.

References ccgsl_pointer, and size1().

◆ rbegin() [2/2]

const_reverse_iterator gsl::matrix_char::rbegin ( ) const

inline

Get iterator pointing to first vector_char element.

Returns: iterator pointing to first vector_char element

Definition at line 671 of file matrix_char.hpp.

References ccgsl_pointer, and size1().

◆ rend() [1/2]

reverse_iterator gsl::matrix_char::rend ( )

inline

Get iterator pointing beyond last vector_char element.

Returns: iterator pointing beyond last vector_char element

Definition at line 680 of file matrix_char.hpp.

◆ rend() [2/2]

const_reverse_iterator gsl::matrix_char::rend ( ) const

inline

Get iterator pointing beyond last vector_char element.

Returns: iterator pointing beyond last vector_char element

Definition at line 687 of file matrix_char.hpp.

◆ reset()

void gsl::matrix_char::reset ( )

inline

Stop sharing ownership of the shared pointer.

Definition at line 213 of file matrix_char.hpp.

References matrix_char().

◆ row() [1/2]

vector_char gsl::matrix_char::row ( size_t const i )

inline

C++ version of gsl_matrix_char_row().

Parameters

i	A row index

Returns: A row as a vector_char

Definition at line 776 of file matrix_char.hpp.

References get().

Referenced by matrix_char().

◆ row() [2/2]

vector_char const gsl::matrix_char::row ( size_t const i ) const

inline

Another C++ version of gsl_matrix_char_const_row().

Parameters

i	A row index

Returns: A row as a vector_char

Definition at line 999 of file matrix_char.hpp.

References get().

◆ scale()

int gsl::matrix_char::scale ( char const x )

inline

C++ version of gsl_matrix_char_scale().

Parameters

x	constant to multiply this by

Returns: error code on failure

Definition at line 1281 of file matrix_char.hpp.

References get().

◆ scale_columns()

int gsl::matrix_char::scale_columns ( vector_char const & x )

inline

C++ version of gsl_matrix_char_scale_columns().

Parameters

x A scalar

Returns: Error code on failure

Definition at line 1520 of file matrix_char.hpp.

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

◆ scale_rows()

int gsl::matrix_char::scale_rows ( vector_char const & x )

inline

C++ version of gsl_matrix_char_scale_rows().

Parameters

x A scalar

Returns: Error code on failure

Definition at line 1513 of file matrix_char.hpp.

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

◆ set()

void gsl::matrix_char::set	(	size_t const	i,
		size_t const	j,
		char	x
	)

inline

C++ version of gsl_matrix_char_set().

Parameters

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

Definition at line 1321 of file matrix_char.hpp.

References get().

Referenced by matrix_char().

◆ set_all()

void gsl::matrix_char::set_all ( char x )

inline

C++ version of gsl_matrix_char_set_all().

Parameters

x	The value to which all elements are set

Definition at line 1233 of file matrix_char.hpp.

References get().

◆ set_col()

int gsl::matrix_char::set_col	(	size_t const	j,
		vector_char const &	v
	)

inline

C++ version of gsl_matrix_char_set_col().

Parameters

j	The index of the column
v	A vector_char

Returns: error code on failure

Definition at line 1559 of file matrix_char.hpp.

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

◆ set_identity()

void gsl::matrix_char::set_identity ( )

inline

C++ version of gsl_matrix_char_set_identity().

Definition at line 1403 of file matrix_char.hpp.

References get().

◆ set_row()

int gsl::matrix_char::set_row	(	size_t const	i,
		vector_char const &	v
	)

inline

C++ version of gsl_matrix_char_set_row().

Parameters

i	The index of the row
v	A vector_char

Returns: error code on failure

Definition at line 1551 of file matrix_char.hpp.

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

◆ set_zero()

void gsl::matrix_char::set_zero ( )

inline

C++ version of gsl_matrix_char_set_zero().

Definition at line 1228 of file matrix_char.hpp.

References get().

◆ size1()

size_t gsl::matrix_char::size1 ( ) const

inline

The number of rows of the matrix_char.

Returns: The number of rows of the matrix_char

Definition at line 696 of file matrix_char.hpp.

References ccgsl_pointer.

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

◆ size2()

size_t gsl::matrix_char::size2 ( ) const

inline

The number of columns of the matrix_char.

Returns: The number of columns of the matrix_char

Definition at line 701 of file matrix_char.hpp.

References ccgsl_pointer.

Referenced by clone().

◆ sub()

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

inline

C++ version of gsl_matrix_char_sub().

Parameters

b	matrix_char to subtract from this

Returns: error code on failure

Definition at line 1275 of file matrix_char.hpp.

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

◆ subcolumn() [1/2]

vector_char gsl::matrix_char::subcolumn	(	size_t const	j,
		size_t const	offset,
		size_t const	n
	)

inline

C++ version of gsl_matrix_char_subcolumn().

Parameters

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

Returns: A subcolumn as a vector_char

Definition at line 839 of file matrix_char.hpp.

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

◆ subcolumn() [2/2]

vector_char const gsl::matrix_char::subcolumn	(	size_t const	j,
		size_t const	offset,
		size_t const	n
	)		const

inline

Another C++ version of gsl_matrix_char_const_subcolumn().

Parameters

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

Returns: A subcolumn as a vector_char

Definition at line 1062 of file matrix_char.hpp.

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

◆ subdiagonal() [1/2]

vector_char gsl::matrix_char::subdiagonal ( size_t const k )

inline

C++ version of gsl_matrix_char_subdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_char

Definition at line 805 of file matrix_char.hpp.

References get().

◆ subdiagonal() [2/2]

vector_char const gsl::matrix_char::subdiagonal ( size_t const k ) const

inline

Another C++ version of gsl_matrix_char_const_subdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_char

Definition at line 1028 of file matrix_char.hpp.

References get().

◆ submatrix() [1/2]

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

inline

C++ version of gsl_matrix_char_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 766 of file matrix_char.hpp.

References get(), and matrix_char().

◆ submatrix() [2/2]

matrix_char const gsl::matrix_char::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_char_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 989 of file matrix_char.hpp.

References get(), and matrix_char().

◆ subrow() [1/2]

vector_char gsl::matrix_char::subrow	(	size_t const	i,
		size_t const	offset,
		size_t const	n
	)

inline

C++ version of gsl_matrix_char_subrow().

Parameters

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

Returns: A subrow as a vector_char

Definition at line 827 of file matrix_char.hpp.

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

◆ subrow() [2/2]

vector_char const gsl::matrix_char::subrow	(	size_t const	i,
		size_t const	offset,
		size_t const	n
	)		const

inline

Another C++ version of gsl_matrix_char_const_subrow().

Parameters

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

Returns: A subrow as a vector_char

Definition at line 1050 of file matrix_char.hpp.

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

◆ superdiagonal() [1/2]

vector_char gsl::matrix_char::superdiagonal ( size_t const k )

inline

C++ version of gsl_matrix_char_superdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_char

Definition at line 815 of file matrix_char.hpp.

References get().

◆ superdiagonal() [2/2]

vector_char const gsl::matrix_char::superdiagonal ( size_t const k ) const

inline

Another C++ version of gsl_matrix_char_const_superdiagonal().

Parameters

k An index

Returns: Subdiagonal k as a vector_char

Definition at line 1038 of file matrix_char.hpp.

References get().

◆ swap()

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

inline

Swap two matrix_char objects.

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

Parameters

m	The matrix_char to swap with `this`.

Definition at line 735 of file matrix_char.hpp.

References ccgsl_pointer, and count.

◆ swap_columns()

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

inline

C++ version of gsl_matrix_char_swap_columns().

Parameters

i	Index of first column
j	Index of second column

Returns: error code on failure

Definition at line 1417 of file matrix_char.hpp.

References get().

◆ swap_rowcol()

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

inline

C++ version of gsl_matrix_char_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 1425 of file matrix_char.hpp.

References get().

◆ swap_rows()

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

inline

C++ version of gsl_matrix_char_swap_rows().

Parameters

i	Index of first row
j	Index of second row

Returns: error code on failure

Definition at line 1410 of file matrix_char.hpp.

References get().

◆ transpose()

int gsl::matrix_char::transpose ( )

inline

C++ version of gsl_matrix_char_transpose().

Returns: error code on failure.

Definition at line 1430 of file matrix_char.hpp.

References get().

◆ transpose_memcpy()

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

inline

C++ version of gsl_matrix_char_transpose_memcpy().

Parameters

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

Returns: error code on failure

Definition at line 1436 of file matrix_char.hpp.

References get().

◆ transpose_tricpy()

void gsl::matrix_char::transpose_tricpy	(	CBLAS_UPLO_t	Uplo,
		CBLAS_DIAG_t	Diag,
		matrix_char 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 754 of file matrix_char.hpp.

References get().

◆ tricpy()

void gsl::matrix_char::tricpy	(	CBLAS_UPLO_t	Uplo,
		CBLAS_DIAG_t	Diag,
		matrix_char 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 745 of file matrix_char.hpp.

References get().

◆ unique()

bool gsl::matrix_char::unique ( ) const

inline

Find if this is the only object sharing the gsl_matrix_char.

Returns: true or falses according as this is the only matrix_char object sharing the gsl_matrix_char

Definition at line 1201 of file matrix_char.hpp.

References count.

◆ use_count()

size_t gsl::matrix_char::use_count ( ) const

inline

Find how many matrix_char objects share this pointer.

Returns: the number of matrix_char objects that share this pointer

Definition at line 1206 of file matrix_char.hpp.

References count.

◆ view_array() [1/2]

static matrix_char gsl::matrix_char::view_array	(	char *	base,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_char_view_array().

Parameters

base	An array of type char
n1	The number of rows
n2	The number of columns

Returns: A matrix_char

Definition at line 851 of file matrix_char.hpp.

References matrix_char().

◆ view_array() [2/2]

static matrix_char const gsl::matrix_char::view_array	(	char const *	base,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

Another C++ version of gsl_matrix_char_const_view_array().

Parameters

base	An array of type char
n1	The number of rows
n2	The number of columns

Returns: A matrix_char

Definition at line 1126 of file matrix_char.hpp.

References matrix_char().

◆ view_array_with_tda() [1/2]

static matrix_char gsl::matrix_char::view_array_with_tda	(	char *	base,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_char_view_array_with_tda().

Parameters

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

Returns: A matrix_char

Definition at line 864 of file matrix_char.hpp.

References matrix_char().

◆ view_array_with_tda() [2/2]

static matrix_char const gsl::matrix_char::view_array_with_tda	(	char const *	base,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

Another C++ version of gsl_matrix_char_const_view_array_with_tda().

Parameters

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

Returns: A matrix_char

Definition at line 1140 of file matrix_char.hpp.

References matrix_char().

◆ view_vector() [1/2]

static matrix_char gsl::matrix_char::view_vector	(	vector_char &	v,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

C++ version of gsl_matrix_char_view_vector().

Parameters

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

Returns: A matrix_char

Definition at line 876 of file matrix_char.hpp.

References gsl::vector_char::get(), and matrix_char().

◆ view_vector() [2/2]

static matrix_char const gsl::matrix_char::view_vector	(	vector_char const &	v,
		size_t const	n1,
		size_t const	n2
	)

inlinestatic

Another C++ version of gsl_matrix_char_const_view_vector().

Parameters

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

Returns: A matrix_char

Definition at line 1152 of file matrix_char.hpp.

References gsl::vector_char::get(), and matrix_char().

◆ view_vector_with_tda() [1/2]

static matrix_char gsl::matrix_char::view_vector_with_tda	(	vector_char &	v,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

C++ version of gsl_matrix_char_view_vector_with_tda().

Parameters

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

Returns: A matrix_char

Definition at line 889 of file matrix_char.hpp.

References gsl::vector_char::get(), and matrix_char().

◆ view_vector_with_tda() [2/2]

static matrix_char const gsl::matrix_char::view_vector_with_tda	(	vector_char const &	v,
		size_t const	n1,
		size_t const	n2,
		size_t const	tda
	)

inlinestatic

Another C++ version of gsl_matrix_char_const_view_vector_with_tda().

Parameters

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

Returns: A matrix_char

Definition at line 1166 of file matrix_char.hpp.

References gsl::vector_char::get(), and matrix_char().

◆ wrap_gsl_matrix_char_without_ownership()

void gsl::matrix_char::wrap_gsl_matrix_char_without_ownership ( gsl_matrix_char * v )

inline

This function is intended mainly for internal use.

It allows this to point to a gsl_matrix_char without the possibility deleting it when this is no longer in scope. It is the responsibility of the programmer to delete v. The function is used internally for converting a function that takes a gsl::matrix_char* argument to one that takes a gsl_matrix_char* argument.

Parameters

v	The gsl_matrix_char

Definition at line 197 of file matrix_char.hpp.

References ccgsl_pointer, count, and owns_data.

Member Data Documentation

◆ ccgsl_pointer

gsl_matrix_char* gsl::matrix_char::ccgsl_pointer

private

The shared pointer.

Definition at line 1179 of file matrix_char.hpp.

Referenced by data(), end(), get(), matrix_char(), operator bool(), operator=(), operator[](), rbegin(), size1(), size2(), swap(), wrap_gsl_matrix_char_without_ownership(), and ~matrix_char().

◆ count

size_t* gsl::matrix_char::count

private

The shared reference count.

Definition at line 1183 of file matrix_char.hpp.

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

◆ owns_data

bool gsl::matrix_char::owns_data

private

Used to allow a vector that does not own its data.

Definition at line 1175 of file matrix_char.hpp.

Referenced by matrix_char(), operator=(), wrap_gsl_matrix_char_without_ownership(), and ~matrix_char().

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

matrix_char.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_char() [1/8]

◆ matrix_char() [2/8]

◆ matrix_char() [3/8]

◆ matrix_char() [4/8]

◆ matrix_char() [5/8]

◆ ~matrix_char()

◆ matrix_char() [6/8]

◆ matrix_char() [7/8]

◆ matrix_char() [8/8]

Member Function Documentation

◆ add()

◆ add_constant()

◆ add_diagonal()

◆ begin() [1/2]

◆ begin() [2/2]

◆ calloc()

◆ clone()

◆ column() [1/2]

◆ column() [2/2]

◆ 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()

◆ data() [1/2]

◆ data() [2/2]

◆ 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()

◆ max()

◆ max_index()

◆ memcpy()

◆ min()

◆ min_index()

◆ minmax() [1/2]

◆ minmax() [2/2]

◆ minmax_index()

◆ mul_elements()

◆ norm1()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]