This class handles sparse matrix_uchar objects as shared handles. More...

#include <spmatrix_uchar.hpp>

Collaboration diagram for gsl::spmatrix_uchar:

Public Types
enum	{ COO = GSL_SPMATRIX_COO , CSC = GSL_SPMATRIX_CSC , CSR = GSL_SPMATRIX_CSR , TRIPLET = GSL_SPMATRIX_TRIPLET , CCS = GSL_SPMATRIX_CCS , CRS = GSL_SPMATRIX_CRS }
	Reference to GSL_SPMATRIX constants. More...

Public Member Functions
	spmatrix_uchar ()
	The default constructor is only really useful for assigning to. More...

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

	spmatrix_uchar (size_t const n1, size_t const n2, size_t nzmax, size_t sptype)
	This constructor creates a new matrix_uchar with n1 rows and n2 columns. More...

	spmatrix_uchar (gsl_spmatrix_uchar *v)
	Could construct from a gsl_spmatrix_uchar. More...

	spmatrix_uchar (std::initializer_list< std::initializer_list< unsigned char > > initializer_list)
	Could construct from a std::initializer_list in C++11 and later. More...

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

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

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

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

void	wrap_gsl_spmatrix_uchar_without_ownership (gsl_spmatrix_uchar *v)
	This function is intended mainly for internal use. More...

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

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

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

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

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

size_t	nzmax () const
	The maximum number of nonzero elements. More...

int	sptype () const
	The type of the spmatrix_uchar. More...

unsigned char *	data ()
	Give access to the data block. More...

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

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

int	realloc (size_t const nzmax)
	C++ version of gsl_spmatrix_uchar_realloc(). More...

size_t	nnz () const
	C++ version of gsl_spmatrix_uchar_nnz(). More...

char const *	type () const
	C++ version of gsl_spmatrix_uchar_type(). More...

int	set_zero ()
	C++ version of gsl_spmatrix_uchar_set_zero(). More...

int	tree_rebuild ()
	C++ version of gsl_spmatrix_uchar_tree_rebuild(). More...

spmatrix_uchar	csc () const
	C++ version of gsl_spmatrix_uchar_csc(). More...

spmatrix_uchar	csr () const
	C++ version of gsl_spmatrix_uchar_csr(). More...

spmatrix_uchar	compress (int const sptype) const
	C++ version of gsl_spmatrix_uchar_compress(). More...

spmatrix_uchar	compcol () const
	C++ version of gsl_spmatrix_uchar_compcol(). More...

spmatrix_uchar	ccs () const
	C++ version of gsl_spmatrix_uchar_ccs(). More...

spmatrix_uchar	crs () const
	C++ version of gsl_spmatrix_uchar_crs(). More...

int	memcpy (spmatrix_uchar &dest) const
	C++ version of gsl_spmatrix_uchar_memcpy(). More...

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

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

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

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

int	set (size_t const i, size_t const j, unsigned char const x)
	C++ version of gsl_spmatrix_uchar_set(). More...

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

int	minmax (unsigned char &min_out, unsigned char &max_out) const
	C++ version of gsl_spmatrix_uchar_minmax(). More...

int	min_index (size_t &imin_out, size_t &jmin_out) const
	C++ version of gsl_spmatrix_uchar_min_index(). More...

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

int	scale_columns (gsl::vector_uchar const &x)
	C++ version of gsl_spmatrix_uchar_scale_columns(). More...

int	scale_rows (gsl::vector_uchar const &x)
	C++ version of gsl_spmatrix_uchar_scale_rows(). More...

int	equal (spmatrix_uchar const &b) const
	C++ version of gsl_spmatrix_uchar_equal(). More...

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

int	transpose2 ()
	C++ version of gsl_spmatrix_uchar_transpose2(). More...

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

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

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

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

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

Static Public Member Functions
static int	realloc (size_t const nzmax, gsl::spmatrix_uchar &spMatrix)
	C++ version of gsl_spmatrix_uchar_realloc(): matches a function in gsl that is intended for internal use. More...

static size_t	nnz (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_nnz(). More...

static char const *	type (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_type(). More...

static int	set_zero (spmatrix_uchar &spMatrix)
	C++ version of gsl_spmatrix_uchar_set_zero(). More...

static int	tree_rebuild (spmatrix_uchar &spMatrix)
	C++ version of gsl_spmatrix_uchar_tree_rebuild(). More...

static spmatrix_uchar	csc (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_csc(). More...

static spmatrix_uchar	csr (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_csr(). More...

static spmatrix_uchar	compress (spmatrix_uchar const &spMatrix, int const sptype)
	C++ version of gsl_spmatrix_uchar_compress(). More...

static spmatrix_uchar	compcol (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_compcol(). More...

static spmatrix_uchar	ccs (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_ccs(). More...

static spmatrix_uchar	crs (spmatrix_uchar const &spMatrix)
	C++ version of gsl_spmatrix_uchar_crs(). More...

static int	memcpy (spmatrix_uchar &dest, spmatrix_uchar const &src)
	C++ version of gsl_spmatrix_uchar_memcpy(). More...

static int	fprintf (FILE stream, spmatrix_uchar const &spMatrix, char const format)
	C++ version of gsl_spmatrix_uchar_fprintf(). More...

static spmatrix_uchar	fscanf (FILE *stream)
	C++ version of gsl_spmatrix_uchar_fscanf(). More...

static int	fwrite (FILE *stream, spmatrix_uchar &spMatrix)
	C++ version of gsl_spmatrix_uchar_fwrite(). More...

static int	fread (FILE *stream, spmatrix_uchar &spMatrix)
	C++ version of gsl_spmatrix_uchar_fread(). More...

static int	add (spmatrix_uchar &c, spmatrix_uchar const &a, spmatrix_uchar const &b)
	C++ version of gsl_spmatrix_uchar_add(). More...

static spmatrix_uchar	add (spmatrix_uchar const &a, spmatrix_uchar const &b)
	C++ version of gsl_spmatrix_uchar_add(). More...

static int	add_to_dense (gsl::matrix_uchar &a, spmatrix_uchar const &b)
	C++ version of gsl_spmatrix_add_to_dense(). More...

static int	dense_add (gsl::matrix_uchar &a, spmatrix_uchar const &b)
	C++ version of gsl_spmatrix_dense_add(). More...

static int	dense_sub (gsl::matrix_uchar &a, spmatrix_uchar const &b)
	C++ version of gsl_spmatrix_dense_sub(). More...

static uchar	norm1 (gsl::spmatrix_uchar const &a)
	C++ version of gsl_spmatrix_uchar_norm1(). More...

static int	d2sp (gsl::spmatrix_uchar &S, gsl::matrix_uchar const &A)
	C++ version of gsl_spmatrix_uchar_d2sp(). More...

static int	sp2d (gsl::matrix_uchar &A, spmatrix_uchar const &S)
	C++ version of gsl_spmatrix_uchar_sp2d(). More...

static int	equal (spmatrix_uchar const &a, spmatrix_uchar const &b)
	C++ version of gsl_spmatrix_uchar_equal(). More...

static int	transpose (spmatrix_uchar &a)
	C++ version of gsl_spmatrix_uchar_transpose(). More...

static int	transpose2 (spmatrix_uchar &a)
	C++ version of gsl_spmatrix_uchar_transpose2(). More...

static int	transpose_memcpy (spmatrix_uchar &dest, spmatrix_uchar const &src)
	C++ version of gsl_spmatrix_uchar_transpose_memcpy(). More...

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

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

Detailed Description

This class handles sparse matrix_uchar objects as shared handles.

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

Definition at line 37 of file spmatrix_uchar.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Reference to GSL_SPMATRIX constants.

Enumerator
COO	GSL_SPMATRIX_COO.
CSC	GSL_SPMATRIX_CSC.
CSR	GSL_SPMATRIX_CSR.
TRIPLET	GSL_SPMATRIX_TRIPLET.
CCS	GSL_SPMATRIX_CCS.
CRS	GSL_SPMATRIX_CRS.

Definition at line 42 of file spmatrix_uchar.hpp.

Constructor & Destructor Documentation

◆ spmatrix_uchar() [1/7]

gsl::spmatrix_uchar::spmatrix_uchar ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 59 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

Referenced by operator=(), and reset().

◆ spmatrix_uchar() [2/7]

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

inlineexplicit

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

Parameters

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

Definition at line 70 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

◆ spmatrix_uchar() [3/7]

gsl::spmatrix_uchar::spmatrix_uchar	(	size_t const	n1,
		size_t const	n2,
		size_t	nzmax,
		size_t	sptype
	)

inlineexplicit

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

Parameters

n1	The number of rows in the matrix_uchar
n2	The number of columns in the matrix_uchar
nzmax	The maximum number of nonzero elements that will be added to the matrix_uchar
sptype	The storage format of the sparse matrix_uchar: one of gsl::spmatrix_uchar::COO, gsl::spmatrix_uchar::CSC or gsl::spmatrix_uchar::CSR

Definition at line 91 of file spmatrix_uchar.hpp.

References ccgsl_pointer, count, nzmax(), and sptype().

◆ spmatrix_uchar() [4/7]

gsl::spmatrix_uchar::spmatrix_uchar ( gsl_spmatrix_uchar * v )

inlineexplicit

Could construct from a gsl_spmatrix_uchar.

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

Parameters

v	The matrix_uchar

Definition at line 110 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

◆ spmatrix_uchar() [5/7]

gsl::spmatrix_uchar::spmatrix_uchar ( std::initializer_list< std::initializer_list< unsigned char > > initializer_list )

inline

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

Parameters

initializer_list The initializer_list.

Definition at line 121 of file spmatrix_uchar.hpp.

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

◆ spmatrix_uchar() [6/7]

gsl::spmatrix_uchar::spmatrix_uchar ( spmatrix_uchar const & v )

inline

The copy constructor.

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

Parameters

v	The spmatrix_uchar to copy.

Definition at line 154 of file spmatrix_uchar.hpp.

References count.

◆ ~spmatrix_uchar()

gsl::spmatrix_uchar::~spmatrix_uchar ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 193 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

◆ spmatrix_uchar() [7/7]

gsl::spmatrix_uchar::spmatrix_uchar ( spmatrix_uchar && v )

inline

Move constructor.

Parameters

v	The spmatrix_uchar to move.

Definition at line 233 of file spmatrix_uchar.hpp.

References count.

Member Function Documentation

◆ add() [1/2]

static int gsl::spmatrix_uchar::add	(	spmatrix_uchar &	c,
		spmatrix_uchar const &	a,
		spmatrix_uchar const &	b
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_add().

Parameters

c	An spmatrix_uchar object
a	An spmatrix_uchar object
b	An spmatrix_uchar object

Returns: Error code on failure

Definition at line 610 of file spmatrix_uchar.hpp.

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

◆ add() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::add	(	spmatrix_uchar const &	a,
		spmatrix_uchar const &	b
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_add().

Parameters

a	An spmatrix_uchar object
b	An spmatrix_uchar object

Returns: The sum of a and b

Definition at line 618 of file spmatrix_uchar.hpp.

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

◆ add_to_dense()

static int gsl::spmatrix_uchar::add_to_dense	(	gsl::matrix_uchar &	a,
		spmatrix_uchar const &	b
	)

inlinestatic

C++ version of gsl_spmatrix_add_to_dense().

Parameters

a	A gsl::matrix_uchar (return value is sum)
b	A gsl::spmatrix_uchar

Returns: Error code on failure

Definition at line 630 of file spmatrix_uchar.hpp.

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

◆ ccs() [1/2]

spmatrix_uchar gsl::spmatrix_uchar::ccs ( ) const

inline

C++ version of gsl_spmatrix_uchar_ccs().

Returns: A compressed matrix_uchar

Definition at line 357 of file spmatrix_uchar.hpp.

References get().

◆ ccs() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::ccs ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_ccs().

Parameters

spMatrix An spmatrix_uchar object

Returns: A compressed matrix_uchar

Definition at line 552 of file spmatrix_uchar.hpp.

References get().

◆ clone()

spmatrix_uchar gsl::spmatrix_uchar::clone ( ) const

inline

The clone function.

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

Returns: a new copy of this.

Definition at line 182 of file spmatrix_uchar.hpp.

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

◆ compcol() [1/2]

spmatrix_uchar gsl::spmatrix_uchar::compcol ( ) const

inline

C++ version of gsl_spmatrix_uchar_compcol().

Returns: A compressed matrix_uchar

Definition at line 350 of file spmatrix_uchar.hpp.

References get().

◆ compcol() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::compcol ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_compcol().

Parameters

spMatrix An spmatrix_uchar object

Returns: A compressed matrix_uchar

Definition at line 544 of file spmatrix_uchar.hpp.

References get().

◆ compress() [1/2]

spmatrix_uchar gsl::spmatrix_uchar::compress ( int const sptype ) const

inline

C++ version of gsl_spmatrix_uchar_compress().

Parameters

sptype One of gsl::spmatrix_uchar::COO, gsl::spmatrix_uchar::CSC or gsl::spmatrix_uchar::CSR

Returns: The compressed matrix_uchar

Definition at line 343 of file spmatrix_uchar.hpp.

References get(), and sptype().

◆ compress() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::compress	(	spmatrix_uchar const &	spMatrix,
		int const	sptype
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_compress().

Parameters

spMatrix	An spmatrix_uchar object
sptype	One of gsl::spmatrix_uchar::COO, gsl::spmatrix_uchar::CSC or gsl::spmatrix_uchar::CSR

Returns: The compressed matrix_uchar

Definition at line 536 of file spmatrix_uchar.hpp.

References get(), and sptype().

◆ crs() [1/2]

spmatrix_uchar gsl::spmatrix_uchar::crs ( ) const

inline

C++ version of gsl_spmatrix_uchar_crs().

Returns: A compressed matrix_uchar

Definition at line 364 of file spmatrix_uchar.hpp.

References get().

◆ crs() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::crs ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_crs().

Parameters

spMatrix An spmatrix_uchar object

Returns: A compressed matrix_uchar

Definition at line 560 of file spmatrix_uchar.hpp.

References get().

◆ csc() [1/2]

spmatrix_uchar gsl::spmatrix_uchar::csc ( ) const

inline

C++ version of gsl_spmatrix_uchar_csc().

Returns: a sparse matrix_uchar in compressed sparse column format from this which must be in COO format

Definition at line 323 of file spmatrix_uchar.hpp.

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

◆ csc() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::csc ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_csc().

Sets dest to a sparse matrix_uchar in compressed sparse column format from the input sparse matrix_uchar src, which must be in COO format

Parameters

spMatrix An spmatrix_uchar object

Returns: Error code on failure

Definition at line 516 of file spmatrix_uchar.hpp.

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

◆ csr() [1/2]

spmatrix_uchar gsl::spmatrix_uchar::csr ( ) const

inline

C++ version of gsl_spmatrix_uchar_csr().

Returns: a sparse matrix_uchar in compressed sparse row format from this which must be in COO format

Definition at line 333 of file spmatrix_uchar.hpp.

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

◆ csr() [2/2]

static spmatrix_uchar gsl::spmatrix_uchar::csr ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_csr().

Sets dest to a sparse matrix_uchar in compressed sparse row format from the input sparse matrix_uchar src, which must be in COO format

Parameters

spMatrix An spmatrix_uchar object

Returns: Error code on failure

Definition at line 526 of file spmatrix_uchar.hpp.

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

◆ d2sp()

static int gsl::spmatrix_uchar::d2sp	(	gsl::spmatrix_uchar &	S,
		gsl::matrix_uchar const &	A
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_d2sp().

Parameters

S	A gsl::spmatrix_uchar (return value)
A	A gsl::matrix_uchar

Returns: Error code on failure

Definition at line 662 of file spmatrix_uchar.hpp.

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

◆ data() [1/2]

unsigned char * gsl::spmatrix_uchar::data ( )

inline

Give access to the data block.

Returns: The data block.

Definition at line 273 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

◆ data() [2/2]

unsigned char const * gsl::spmatrix_uchar::data ( ) const

inline

Give access to the data block.

Returns: The data block.

Definition at line 280 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

◆ dense_add()

static int gsl::spmatrix_uchar::dense_add	(	gsl::matrix_uchar &	a,
		spmatrix_uchar const &	b
	)

inlinestatic

C++ version of gsl_spmatrix_dense_add().

Parameters

a	A gsl::matrix_uchar (return value is sum)
b	A gsl::spmatrix_uchar

Returns: Error code on failure

Definition at line 639 of file spmatrix_uchar.hpp.

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

◆ dense_sub()

static int gsl::spmatrix_uchar::dense_sub	(	gsl::matrix_uchar &	a,
		spmatrix_uchar const &	b
	)

inlinestatic

C++ version of gsl_spmatrix_dense_sub().

Parameters

a	A gsl::matrix_uchar (return value is difference)
b	A gsl::spmatrix_uchar

Returns: Error code on failure

Definition at line 647 of file spmatrix_uchar.hpp.

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

◆ equal() [1/2]

static int gsl::spmatrix_uchar::equal	(	spmatrix_uchar const &	a,
		spmatrix_uchar const &	b
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_equal().

Parameters

a	An spmatrix_uchar
b	An spmatrix_uchar

Returns: 1 or 0 according as a and b are equal or not

Definition at line 678 of file spmatrix_uchar.hpp.

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

◆ equal() [2/2]

int gsl::spmatrix_uchar::equal ( spmatrix_uchar const & b ) const

inline

C++ version of gsl_spmatrix_uchar_equal().

Parameters

b	An spmatrix_uchar

Returns: 1 or 0 according as a and b are equal or not

Definition at line 461 of file spmatrix_uchar.hpp.

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

◆ fprintf() [1/2]

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

inline

C++ version of gsl_spmatrix_uchar_fprintf().

Parameters

stream	A file stream
format	One of the g, e or f formats for floating point numbers

Returns: Error code on failure

Definition at line 379 of file spmatrix_uchar.hpp.

References get().

◆ fprintf() [2/2]

static int gsl::spmatrix_uchar::fprintf	(	FILE *	stream,
		spmatrix_uchar const &	spMatrix,
		char const *	format
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_fprintf().

Parameters

stream	A file stream
spMatrix	An spmatrix_uchar object
format	One of the g, e or f formats for floating point numbers

Returns: Error code on failure

Definition at line 578 of file spmatrix_uchar.hpp.

References get().

◆ fread() [1/2]

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

inline

C++ version of gsl_spmatrix_uchar_fread().

Parameters

stream A file stream

Returns: Error code on failure

Definition at line 393 of file spmatrix_uchar.hpp.

References get().

◆ fread() [2/2]

static int gsl::spmatrix_uchar::fread	(	FILE *	stream,
		spmatrix_uchar &	spMatrix
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_fread().

Parameters

stream	A file stream
spMatrix	An spmatrix_uchar object

Returns: Error code on failure

Definition at line 601 of file spmatrix_uchar.hpp.

References get().

◆ fscanf()

static spmatrix_uchar gsl::spmatrix_uchar::fscanf ( FILE * stream )

inlinestatic

C++ version of gsl_spmatrix_uchar_fscanf().

Parameters

stream A file stream

Returns: The spMatrix read from a file stream

Definition at line 585 of file spmatrix_uchar.hpp.

◆ fwrite() [1/2]

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

inline

C++ version of gsl_spmatrix_uchar_fwrite().

Parameters

stream A file stream

Returns: Error code on failure

Definition at line 386 of file spmatrix_uchar.hpp.

References get().

◆ fwrite() [2/2]

static int gsl::spmatrix_uchar::fwrite	(	FILE *	stream,
		spmatrix_uchar &	spMatrix
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_fwrite().

Parameters

stream	A file stream
spMatrix	An spmatrix_uchar object

Returns: Error code on failure

Definition at line 593 of file spmatrix_uchar.hpp.

References get().

◆ get() [1/3]

gsl_spmatrix_uchar * gsl::spmatrix_uchar::get ( )

inline

Get the gsl_spmatrix_uchar.

Returns: the gsl_spmatrix_uchar

Definition at line 715 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

Referenced by ccs(), clone(), compcol(), compress(), crs(), csc(), csr(), equal(), fprintf(), fread(), fwrite(), get(), memcpy(), min_index(), minmax(), nnz(), ptr(), realloc(), scale(), scale_columns(), scale_rows(), set(), set_zero(), transpose(), transpose2(), tree_rebuild(), and type().

◆ get() [2/3]

gsl_spmatrix_uchar const * gsl::spmatrix_uchar::get ( ) const

inline

Get the gsl_spmatrix_uchar.

Returns: the gsl_spmatrix_uchar

Definition at line 720 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

◆ get() [3/3]

unsigned char gsl::spmatrix_uchar::get	(	size_t const	i,
		size_t const	j
	)		const

inline

C++ version of gsl_spmatrix_uchar_get().

Parameters

i	Row index
j	Column index

Returns: Value in sparse matrix_uchar

Definition at line 401 of file spmatrix_uchar.hpp.

References get().

Referenced by add(), ccs(), clone(), compcol(), compress(), crs(), csc(), csr(), d2sp(), fprintf(), fread(), fwrite(), memcpy(), nnz(), realloc(), set_zero(), sp2d(), transpose_memcpy(), tree_rebuild(), and type().

◆ memcpy() [1/2]

int gsl::spmatrix_uchar::memcpy ( spmatrix_uchar & dest ) const

inline

C++ version of gsl_spmatrix_uchar_memcpy().

Parameters

dest	The destination spmatrix_uchar

Returns: Error code on failure

Definition at line 372 of file spmatrix_uchar.hpp.

References get().

◆ memcpy() [2/2]

static int gsl::spmatrix_uchar::memcpy	(	spmatrix_uchar &	dest,
		spmatrix_uchar const &	src
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_memcpy().

Parameters

dest	The destination spmatrix_uchar
src	The source spmatrix_uchar

Returns: Error code on failure

Definition at line 569 of file spmatrix_uchar.hpp.

References get().

◆ min_index()

int gsl::spmatrix_uchar::min_index	(	size_t &	imin_out,
		size_t &	jmin_out
	)		const

inline

C++ version of gsl_spmatrix_uchar_min_index().

Parameters

imin_out	The row index of the minimum nonzero element (by reference)
jmin_out	The column index of the minimum nonzero element (by reference)

Returns: Error code on failure

Definition at line 434 of file spmatrix_uchar.hpp.

References get().

◆ minmax()

int gsl::spmatrix_uchar::minmax	(	unsigned char &	min_out,
		unsigned char &	max_out
	)		const

inline

C++ version of gsl_spmatrix_uchar_minmax().

Parameters

min_out	The minimum element (by reference)
max_out	The maximum element (by reference)

Returns: Error code on failure

Definition at line 426 of file spmatrix_uchar.hpp.

References get().

◆ nnz() [1/2]

size_t gsl::spmatrix_uchar::nnz ( ) const

inline

C++ version of gsl_spmatrix_uchar_nnz().

Returns: The number of nonzero elements of this

Definition at line 302 of file spmatrix_uchar.hpp.

References get().

◆ nnz() [2/2]

static size_t gsl::spmatrix_uchar::nnz ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_nnz().

Parameters

spMatrix An spmatrix_uchar object

Returns: The number of nonzero elements of spMatrix

Definition at line 487 of file spmatrix_uchar.hpp.

References get().

◆ norm1()

static uchar gsl::spmatrix_uchar::norm1 ( gsl::spmatrix_uchar const & a )

inlinestatic

C++ version of gsl_spmatrix_uchar_norm1().

Parameters

a	A gsl::spmatrix_uchar

Returns: The 1-norm

Definition at line 654 of file spmatrix_uchar.hpp.

References gsl::sf::mathieu::a().

◆ nzmax()

size_t gsl::spmatrix_uchar::nzmax ( ) const

inline

The maximum number of nonzero elements.

Returns: the maximum number of nonzero elements

Definition at line 263 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

Referenced by realloc(), and spmatrix_uchar().

◆ operator bool()

gsl::spmatrix_uchar::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

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

Definition at line 740 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

◆ operator=() [1/2]

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

inline

Move operator.

Parameters

v	The spmatrix_uchar to move.

Returns: A reference to this.

Definition at line 242 of file spmatrix_uchar.hpp.

References spmatrix_uchar().

◆ operator=() [2/2]

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

inline

The assignment operator.

This makes a shared copy.

Parameters

v	The matrix_uchar to copy

Definition at line 162 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

◆ ptr()

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

inline

C++ version of gsl_spmatrix_uchar_ptr().

Parameters

i	Row index
j	Column index

Returns: Error code on failure

Definition at line 418 of file spmatrix_uchar.hpp.

References get().

◆ realloc() [1/2]

int gsl::spmatrix_uchar::realloc ( size_t const nzmax )

inline

C++ version of gsl_spmatrix_uchar_realloc().

This is not usually used.

Parameters

nzmax The maximum number of nonzero elements

Returns: Error code on failure

Definition at line 297 of file spmatrix_uchar.hpp.

References get(), and nzmax().

◆ realloc() [2/2]

static int gsl::spmatrix_uchar::realloc	(	size_t const	nzmax,
		gsl::spmatrix_uchar &	spMatrix
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_realloc(): matches a function in gsl that is intended for internal use.

Parameters

nzmax	The maximum number of nonzero elements
spMatrix	An spmatrix_uchar object

Returns: Error code on failure

Definition at line 480 of file spmatrix_uchar.hpp.

References get(), and nzmax().

◆ reset()

void gsl::spmatrix_uchar::reset ( )

inline

Stop sharing ownership of the shared pointer.

Definition at line 227 of file spmatrix_uchar.hpp.

References spmatrix_uchar().

◆ scale()

int gsl::spmatrix_uchar::scale ( unsigned char const x )

inline

C++ version of gsl_spmatrix_uchar_scale().

Parameters

x	A scaling factor

Returns: Error code on failure

Definition at line 441 of file spmatrix_uchar.hpp.

References get().

◆ scale_columns()

int gsl::spmatrix_uchar::scale_columns ( gsl::vector_uchar const & x )

inline

C++ version of gsl_spmatrix_uchar_scale_columns().

Parameters

x	A scaling gsl::vector_uchar

Returns: Error code on failure

Definition at line 447 of file spmatrix_uchar.hpp.

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

◆ scale_rows()

int gsl::spmatrix_uchar::scale_rows ( gsl::vector_uchar const & x )

inline

C++ version of gsl_spmatrix_uchar_scale_rows().

Parameters

x	A scaling gsl::vector_uchar

Returns: Error code on failure

Definition at line 454 of file spmatrix_uchar.hpp.

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

◆ set()

int gsl::spmatrix_uchar::set	(	size_t const	i,
		size_t const	j,
		unsigned char const	x
	)

inline

C++ version of gsl_spmatrix_uchar_set().

Parameters

i	Row index
j	Column value
x	New matrix_uchar entry

Returns: Error code on failure

Definition at line 410 of file spmatrix_uchar.hpp.

References get().

Referenced by spmatrix_uchar().

◆ set_zero() [1/2]

int gsl::spmatrix_uchar::set_zero ( )

inline

C++ version of gsl_spmatrix_uchar_set_zero().

Reinitialise spmatrix_uchar to zeros.

Returns: Error code on failure

Definition at line 312 of file spmatrix_uchar.hpp.

References get().

◆ set_zero() [2/2]

static int gsl::spmatrix_uchar::set_zero ( spmatrix_uchar & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_set_zero().

Reinitialise spmatrix_uchar to zeros.

Parameters

spMatrix An spmatrix_uchar object

Returns: Error code on failure

Definition at line 501 of file spmatrix_uchar.hpp.

References get().

◆ size1()

size_t gsl::spmatrix_uchar::size1 ( ) const

inline

The number of rows of the matrix_uchar.

Returns: The number of rows of the matrix_uchar

Definition at line 253 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

Referenced by clone(), csc(), and csr().

◆ size2()

size_t gsl::spmatrix_uchar::size2 ( ) const

inline

The number of columns of the matrix_uchar.

Returns: The number of columns of the matrix_uchar

Definition at line 258 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

Referenced by clone(), csc(), and csr().

◆ sp2d()

static int gsl::spmatrix_uchar::sp2d	(	gsl::matrix_uchar &	A,
		spmatrix_uchar const &	S
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_sp2d().

Parameters

A	A gsl::matrix_uchar (return value)
S	A gsl::spmatrix_uchar

Returns: Error code on failure

Definition at line 670 of file spmatrix_uchar.hpp.

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

◆ sptype()

int gsl::spmatrix_uchar::sptype ( ) const

inline

The type of the spmatrix_uchar.

Returns: the type of the spmatrix_uchar

Definition at line 268 of file spmatrix_uchar.hpp.

References ccgsl_pointer.

Referenced by compress(), and spmatrix_uchar().

◆ swap()

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

inline

Swap two spmatrix_uchar objects.

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

Parameters

m	The spmatrix_uchar to swap with `this`.

Definition at line 288 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

◆ transpose() [1/2]

int gsl::spmatrix_uchar::transpose ( )

inline

C++ version of gsl_spmatrix_uchar_transpose().

Returns: Error code on failure

Definition at line 466 of file spmatrix_uchar.hpp.

References get().

◆ transpose() [2/2]

static int gsl::spmatrix_uchar::transpose ( spmatrix_uchar & a )

inlinestatic

C++ version of gsl_spmatrix_uchar_transpose().

Parameters

a	An spmatrix_uchar

Returns: Error code on failure

Definition at line 685 of file spmatrix_uchar.hpp.

References gsl::sf::mathieu::a().

◆ transpose2() [1/2]

int gsl::spmatrix_uchar::transpose2 ( )

inline

C++ version of gsl_spmatrix_uchar_transpose2().

Returns: Error code on failure

Definition at line 471 of file spmatrix_uchar.hpp.

References get().

◆ transpose2() [2/2]

static int gsl::spmatrix_uchar::transpose2 ( spmatrix_uchar & a )

inlinestatic

C++ version of gsl_spmatrix_uchar_transpose2().

Parameters

a	An spmatrix_uchar

Returns: Error code on failure

Definition at line 691 of file spmatrix_uchar.hpp.

References gsl::sf::mathieu::a().

◆ transpose_memcpy()

static int gsl::spmatrix_uchar::transpose_memcpy	(	spmatrix_uchar &	dest,
		spmatrix_uchar const &	src
	)

inlinestatic

C++ version of gsl_spmatrix_uchar_transpose_memcpy().

Parameters

dest	An spmatrix_uchar (return)
src	An spmatrix_uchar

Returns: Error code on failure

Definition at line 698 of file spmatrix_uchar.hpp.

References get().

◆ tree_rebuild() [1/2]

int gsl::spmatrix_uchar::tree_rebuild ( )

inline

C++ version of gsl_spmatrix_uchar_tree_rebuild().

Returns: Error code on failure

Definition at line 317 of file spmatrix_uchar.hpp.

References get().

◆ tree_rebuild() [2/2]

static int gsl::spmatrix_uchar::tree_rebuild ( spmatrix_uchar & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_tree_rebuild().

Parameters

spMatrix An spmatrix_uchar object

Returns: Error code on failure

Definition at line 508 of file spmatrix_uchar.hpp.

References get().

◆ type() [1/2]

char const * gsl::spmatrix_uchar::type ( ) const

inline

C++ version of gsl_spmatrix_uchar_type().

Returns: A string describing the sparse matrix_uchar storage format

Definition at line 307 of file spmatrix_uchar.hpp.

References get().

◆ type() [2/2]

static char const * gsl::spmatrix_uchar::type ( spmatrix_uchar const & spMatrix )

inlinestatic

C++ version of gsl_spmatrix_uchar_type().

Parameters

spMatrix An spmatrix_uchar object

Returns: A string describing the sparse matrix_uchar storage format

Definition at line 494 of file spmatrix_uchar.hpp.

References get().

◆ unique()

bool gsl::spmatrix_uchar::unique ( ) const

inline

Find if this is the only object sharing the gsl_spmatrix_uchar.

Returns: true or falses according as this is the only spmatrix_uchar object sharing the gsl_spmatrix_uchar

Definition at line 726 of file spmatrix_uchar.hpp.

References count.

◆ use_count()

size_t gsl::spmatrix_uchar::use_count ( ) const

inline

Find how many spmatrix_uchar objects share this pointer.

Returns: the number of spmatrix_uchar objects that share this pointer

Definition at line 731 of file spmatrix_uchar.hpp.

References count.

◆ wrap_gsl_spmatrix_uchar_without_ownership()

void gsl::spmatrix_uchar::wrap_gsl_spmatrix_uchar_without_ownership ( gsl_spmatrix_uchar * v )

inline

This function is intended mainly for internal use.

It allows this to point to a gsl_spmatrix_uchar 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::spmatrix_uchar* argument to one that takes a gsl_spmatrix_uchar* argument.

Parameters

v	The gsl_spmatrix_uchar

Definition at line 212 of file spmatrix_uchar.hpp.

References ccgsl_pointer, and count.

Member Data Documentation

◆ ccgsl_pointer

gsl_spmatrix_uchar* gsl::spmatrix_uchar::ccgsl_pointer

private

The shared pointer.

Definition at line 704 of file spmatrix_uchar.hpp.

Referenced by data(), get(), nzmax(), operator bool(), operator=(), size1(), size2(), spmatrix_uchar(), sptype(), swap(), wrap_gsl_spmatrix_uchar_without_ownership(), and ~spmatrix_uchar().

◆ count

size_t* gsl::spmatrix_uchar::count

private

The shared reference count.

Definition at line 708 of file spmatrix_uchar.hpp.

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

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

spmatrix_uchar.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ spmatrix_uchar() [1/7]

◆ spmatrix_uchar() [2/7]

◆ spmatrix_uchar() [3/7]

◆ spmatrix_uchar() [4/7]

◆ spmatrix_uchar() [5/7]

◆ spmatrix_uchar() [6/7]

◆ ~spmatrix_uchar()

◆ spmatrix_uchar() [7/7]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ add_to_dense()

◆ ccs() [1/2]

◆ ccs() [2/2]

◆ clone()

◆ compcol() [1/2]

◆ compcol() [2/2]

◆ compress() [1/2]

◆ compress() [2/2]

◆ crs() [1/2]

◆ crs() [2/2]

◆ csc() [1/2]

◆ csc() [2/2]

◆ csr() [1/2]

◆ csr() [2/2]

◆ d2sp()

◆ data() [1/2]

◆ data() [2/2]

◆ dense_add()

◆ dense_sub()

◆ equal() [1/2]

◆ equal() [2/2]

◆ fprintf() [1/2]

◆ fprintf() [2/2]

◆ fread() [1/2]

◆ fread() [2/2]

◆ fscanf()

◆ fwrite() [1/2]

◆ fwrite() [2/2]

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ memcpy() [1/2]

◆ memcpy() [2/2]

◆ min_index()

◆ minmax()

◆ nnz() [1/2]

◆ nnz() [2/2]

◆ norm1()

◆ nzmax()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ptr()

◆ realloc() [1/2]

◆ realloc() [2/2]

◆ reset()

◆ scale()

◆ scale_columns()

◆ scale_rows()

◆ set()

◆ set_zero() [1/2]

◆ set_zero() [2/2]

◆ size1()

◆ size2()

◆ sp2d()

◆ sptype()

◆ swap()

◆ transpose() [1/2]

◆ transpose() [2/2]

◆ transpose2() [1/2]

◆ transpose2() [2/2]