#include <shark/LinAlg/BLAS/matrix_sparse.hpp>

Inheritance diagram for shark::blas::compressed_matrix< T, I >:

Classes
class	reference

Public Types
typedef T const *	const_pointer

typedef T *	pointer

typedef index_type const *	const_index_pointer

typedef index_type *	index_pointer

typedef T const &	const_reference

typedef sparse_tag	storage_category

typedef elementwise_tag	evaluation_category

typedef row_major	orientation

typedef compressed_storage_iterator< value_type const, index_type const >	const_row_iterator

typedef compressed_storage_iterator< value_type, index_type const >	row_iterator

typedef compressed_storage_iterator< value_type const, index_type const >	const_column_iterator

typedef compressed_storage_iterator< value_type, index_type const >	column_iterator

Public Member Functions
	compressed_matrix ()

	compressed_matrix (size_type size1, size_type size2, size_type non_zeros=0)

template<class E >
	compressed_matrix (const matrix_expression< E > &e, size_type non_zeros=0)

size_type	size1 () const

size_type	size2 () const

size_type	nnz_capacity () const

size_type	row_capacity (std::size_t row) const

size_type	nnz () const

size_type	inner_nnz (std::size_t row) const

index_type const *	outer_indices () const

index_type const *	outer_indices_end () const

index_type const *	inner_indices () const

value_type const *	values () const

index_type *	outer_indices ()

index_type *	outer_indices_end ()

index_type *	inner_indices ()

value_type *	values ()

void	set_filled (size_type non_zeros)

void	set_row_filled (size_type i, size_type non_zeros)

void	resize (size_type size1, size_type size2)

void	reserve (size_type non_zeros)

void	reserve_row (std::size_t row, std::size_t non_zeros)

void	clear ()

const_reference	operator() (size_type i, size_type j) const

reference	operator() (size_type i, size_type j)

template<class C >
compressed_matrix &	operator= (const matrix_container< C > &m)

template<class E >
compressed_matrix &	operator= (const matrix_expression< E > &e)

void	swap (compressed_matrix &m)

const_row_iterator	row_begin (std::size_t i) const

const_row_iterator	row_end (std::size_t i) const

row_iterator	row_begin (std::size_t i)

row_iterator	row_end (std::size_t i)

row_iterator	set_element (row_iterator pos, size_type index, value_type value)

row_iterator	clear_range (row_iterator start, row_iterator end)

row_iterator	clear_element (row_iterator elem)

template<class Archive >
void	serialize (Archive &ar, const unsigned int)

Public Member Functions inherited from shark::blas::matrix_container< compressed_matrix< T, I > >
const container_type &	operator() () const

container_type &	operator() ()

Public Member Functions inherited from shark::blas::matrix_expression< E >
const expression_type &	operator() () const

expression_type &	operator() ()

Friends
void	swap (compressed_matrix &m1, compressed_matrix &m2)

void	swap_rows (compressed_matrix &a, size_type i, compressed_matrix &b, size_type j)

void	swap_rows (compressed_matrix &a, size_type i, size_type j)

Detailed Description

template<class T, class I = std::size_t>
class shark::blas::compressed_matrix< T, I >

Definition at line 37 of file matrix_sparse.hpp.

Member Typedef Documentation

§ column_iterator

template<class T , class I = std::size_t>

typedef compressed_storage_iterator<value_type, index_type const> shark::blas::compressed_matrix< T, I >::column_iterator

Definition at line 385 of file matrix_sparse.hpp.

§ const_column_iterator

template<class T , class I = std::size_t>

typedef compressed_storage_iterator<value_type const, index_type const> shark::blas::compressed_matrix< T, I >::const_column_iterator

Definition at line 384 of file matrix_sparse.hpp.

§ const_index_pointer

template<class T , class I = std::size_t>

typedef index_type const* shark::blas::compressed_matrix< T, I >::const_index_pointer

Definition at line 48 of file matrix_sparse.hpp.

§ const_pointer

template<class T , class I = std::size_t>

typedef T const* shark::blas::compressed_matrix< T, I >::const_pointer

Definition at line 44 of file matrix_sparse.hpp.

§ const_reference

template<class T , class I = std::size_t>

typedef T const& shark::blas::compressed_matrix< T, I >::const_reference

Definition at line 51 of file matrix_sparse.hpp.

§ const_row_iterator

template<class T , class I = std::size_t>

typedef compressed_storage_iterator<value_type const, index_type const> shark::blas::compressed_matrix< T, I >::const_row_iterator

Definition at line 357 of file matrix_sparse.hpp.

§ evaluation_category

template<class T , class I = std::size_t>

typedef elementwise_tag shark::blas::compressed_matrix< T, I >::evaluation_category

Definition at line 116 of file matrix_sparse.hpp.

§ index_pointer

template<class T , class I = std::size_t>

typedef index_type* shark::blas::compressed_matrix< T, I >::index_pointer

Definition at line 49 of file matrix_sparse.hpp.

§ orientation

template<class T , class I = std::size_t>

typedef row_major shark::blas::compressed_matrix< T, I >::orientation

Definition at line 117 of file matrix_sparse.hpp.

§ pointer

template<class T , class I = std::size_t>

typedef T* shark::blas::compressed_matrix< T, I >::pointer

Definition at line 45 of file matrix_sparse.hpp.

§ row_iterator

template<class T , class I = std::size_t>

typedef compressed_storage_iterator<value_type, index_type const> shark::blas::compressed_matrix< T, I >::row_iterator

Definition at line 358 of file matrix_sparse.hpp.

§ storage_category

template<class T , class I = std::size_t>

typedef sparse_tag shark::blas::compressed_matrix< T, I >::storage_category

Definition at line 115 of file matrix_sparse.hpp.

Constructor & Destructor Documentation

§ compressed_matrix() [1/3]

template<class T , class I = std::size_t>

shark::blas::compressed_matrix< T, I >::compressed_matrix ( )

inline

Definition at line 120 of file matrix_sparse.hpp.

§ compressed_matrix() [2/3]

template<class T , class I = std::size_t>

shark::blas::compressed_matrix< T, I >::compressed_matrix	(	size_type	size1,
		size_type	size2,
		size_type	non_zeros = `0`
	)

inline

Definition at line 124 of file matrix_sparse.hpp.

§ compressed_matrix() [3/3]

template<class T , class I = std::size_t>

template<class E >

shark::blas::compressed_matrix< T, I >::compressed_matrix	(	const matrix_expression< E > &	e,
		size_type	non_zeros = `0`
	)

inline

Definition at line 131 of file matrix_sparse.hpp.

References shark::blas::assign().

Member Function Documentation

§ clear()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::clear ( )

inline

Definition at line 259 of file matrix_sparse.hpp.

§ clear_element()

template<class T , class I = std::size_t>

row_iterator shark::blas::compressed_matrix< T, I >::clear_element ( row_iterator elem )

inline

Definition at line 449 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::clear_range(), RANGE_CHECK, and shark::blas::compressed_matrix< T, I >::row_end().

§ clear_range()

template<class T , class I = std::size_t>

row_iterator shark::blas::compressed_matrix< T, I >::clear_range	(	row_iterator	start,
		row_iterator	end
	)

inline

Definition at line 426 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), RANGE_CHECK, shark::blas::row(), shark::blas::compressed_matrix< T, I >::row_begin(), and shark::blas::compressed_matrix< T, I >::values().

Referenced by shark::blas::compressed_matrix< T, I >::clear_element().

§ inner_indices() [1/2]

template<class T , class I = std::size_t>

index_type const* shark::blas::compressed_matrix< T, I >::inner_indices ( ) const

inline

Definition at line 171 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::nnz_capacity().

Referenced by shark::blas::compressed_matrix< T, I >::clear_range(), shark::blas::compressed_matrix< T, I >::operator()(), shark::blas::compressed_matrix< T, I >::reserve_row(), shark::blas::compressed_matrix< T, I >::row_begin(), shark::blas::compressed_matrix< T, I >::row_end(), and shark::blas::compressed_matrix< T, I >::set_element().

§ inner_indices() [2/2]

template<class T , class I = std::size_t>

index_type* shark::blas::compressed_matrix< T, I >::inner_indices ( )

inline

Definition at line 192 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::nnz_capacity().

§ inner_nnz()

template<class T , class I = std::size_t>

size_type shark::blas::compressed_matrix< T, I >::inner_nnz ( std::size_t row ) const

inline

Definition at line 157 of file matrix_sparse.hpp.

References shark::blas::row().

Referenced by shark::blas::compressed_matrix< T, I >::set_element().

§ nnz()

template<class T , class I = std::size_t>

size_type shark::blas::compressed_matrix< T, I >::nnz ( ) const

inline

Definition at line 154 of file matrix_sparse.hpp.

§ nnz_capacity()

template<class T , class I = std::size_t>

size_type shark::blas::compressed_matrix< T, I >::nnz_capacity ( ) const

inline

Definition at line 147 of file matrix_sparse.hpp.

Referenced by shark::blas::compressed_matrix< T, I >::inner_indices(), shark::blas::compressed_matrix< T, I >::operator=(), shark::blas::compressed_matrix< T, I >::reserve(), shark::blas::compressed_matrix< T, I >::reserve_row(), and shark::blas::compressed_matrix< T, I >::values().

§ operator()() [1/2]

template<class T , class I = std::size_t>

const_reference shark::blas::compressed_matrix< T, I >::operator()	(	size_type	i,
		size_type	j
	)		const

inline

Definition at line 265 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), shark::blas::compressed_matrix< T, I >::size1(), shark::blas::compressed_matrix< T, I >::size2(), and SIZE_CHECK.

§ operator()() [2/2]

template<class T , class I = std::size_t>

reference shark::blas::compressed_matrix< T, I >::operator()	(	size_type	i,
		size_type	j
	)

inline

Definition at line 280 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::reference::reference(), shark::blas::compressed_matrix< T, I >::size1(), shark::blas::compressed_matrix< T, I >::size2(), and SIZE_CHECK.

§ operator=() [1/2]

template<class T , class I = std::size_t>

template<class C >

compressed_matrix& shark::blas::compressed_matrix< T, I >::operator= ( const matrix_container< C > & m )

inline

Definition at line 288 of file matrix_sparse.hpp.

References shark::blas::assign(), shark::blas::compressed_matrix< T, I >::resize(), shark::blas::compressed_matrix< T, I >::size1(), and shark::blas::compressed_matrix< T, I >::size2().

§ operator=() [2/2]

template<class T , class I = std::size_t>

template<class E >

compressed_matrix& shark::blas::compressed_matrix< T, I >::operator= ( const matrix_expression< E > & e )

inline

Definition at line 294 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::nnz_capacity(), and shark::blas::compressed_matrix< T, I >::swap().

§ outer_indices() [1/2]

template<class T , class I = std::size_t>

index_type const* shark::blas::compressed_matrix< T, I >::outer_indices ( ) const

inline

Definition at line 161 of file matrix_sparse.hpp.

§ outer_indices() [2/2]

template<class T , class I = std::size_t>

index_type* shark::blas::compressed_matrix< T, I >::outer_indices ( )

inline

Definition at line 182 of file matrix_sparse.hpp.

§ outer_indices_end() [1/2]

template<class T , class I = std::size_t>

index_type const* shark::blas::compressed_matrix< T, I >::outer_indices_end ( ) const

inline

Definition at line 166 of file matrix_sparse.hpp.

§ outer_indices_end() [2/2]

template<class T , class I = std::size_t>

index_type* shark::blas::compressed_matrix< T, I >::outer_indices_end ( )

inline

Definition at line 187 of file matrix_sparse.hpp.

§ reserve()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::reserve ( size_type non_zeros )

inline

Definition at line 227 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::nnz_capacity().

Referenced by shark::blas::compressed_matrix< T, I >::reserve_row().

§ reserve_row()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::reserve_row	(	std::size_t	row,
		std::size_t	non_zeros
	)

inline

Definition at line 234 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), shark::blas::min(), shark::blas::compressed_matrix< T, I >::nnz_capacity(), RANGE_CHECK, shark::blas::compressed_matrix< T, I >::reserve(), shark::blas::row(), shark::blas::compressed_matrix< T, I >::row_capacity(), shark::blas::compressed_matrix< T, I >::size1(), SIZE_CHECK, and shark::blas::compressed_matrix< T, I >::values().

Referenced by shark::blas::compressed_matrix< T, I >::set_element().

§ resize()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::resize	(	size_type	size1,
		size_type	size2
	)

inline

Definition at line 217 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::size1(), and shark::blas::compressed_matrix< T, I >::size2().

Referenced by shark::blas::compressed_matrix< T, I >::operator=().

§ row_begin() [1/2]

template<class T , class I = std::size_t>

const_row_iterator shark::blas::compressed_matrix< T, I >::row_begin ( std::size_t i ) const

inline

Definition at line 360 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), RANGE_CHECK, shark::blas::compressed_matrix< T, I >::size1(), SIZE_CHECK, and shark::blas::compressed_matrix< T, I >::values().

Referenced by shark::blas::compressed_matrix< T, I >::clear_range(), and shark::blas::compressed_matrix< T, I >::set_element().

§ row_begin() [2/2]

template<class T , class I = std::size_t>

row_iterator shark::blas::compressed_matrix< T, I >::row_begin ( std::size_t i )

inline

Definition at line 372 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), RANGE_CHECK, shark::blas::compressed_matrix< T, I >::size1(), SIZE_CHECK, and shark::blas::compressed_matrix< T, I >::values().

§ row_capacity()

template<class T , class I = std::size_t>

size_type shark::blas::compressed_matrix< T, I >::row_capacity ( std::size_t row ) const

inline

Definition at line 150 of file matrix_sparse.hpp.

References RANGE_CHECK, shark::blas::row(), and shark::blas::compressed_matrix< T, I >::size1().

Referenced by shark::blas::compressed_matrix< T, I >::reserve_row(), shark::blas::compressed_matrix< T, I >::set_element(), and shark::blas::compressed_matrix< T, I >::set_row_filled().

§ row_end() [1/2]

template<class T , class I = std::size_t>

const_row_iterator shark::blas::compressed_matrix< T, I >::row_end ( std::size_t i ) const

inline

Definition at line 366 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), RANGE_CHECK, shark::blas::compressed_matrix< T, I >::size1(), SIZE_CHECK, and shark::blas::compressed_matrix< T, I >::values().

Referenced by shark::blas::compressed_matrix< T, I >::clear_element(), and shark::blas::compressed_matrix< T, I >::set_element().

§ row_end() [2/2]

template<class T , class I = std::size_t>

row_iterator shark::blas::compressed_matrix< T, I >::row_end ( std::size_t i )

inline

Definition at line 378 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), RANGE_CHECK, shark::blas::compressed_matrix< T, I >::size1(), SIZE_CHECK, and shark::blas::compressed_matrix< T, I >::values().

§ serialize()

template<class T , class I = std::size_t>

template<class Archive >

void shark::blas::compressed_matrix< T, I >::serialize	(	Archive &	ar,
		const unsigned	int
	)

inline

Definition at line 458 of file matrix_sparse.hpp.

§ set_element()

template<class T , class I = std::size_t>

row_iterator shark::blas::compressed_matrix< T, I >::set_element	(	row_iterator	pos,
		size_type	index,
		value_type	value
	)

inline

Definition at line 387 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::inner_indices(), shark::blas::compressed_matrix< T, I >::inner_nnz(), RANGE_CHECK, shark::blas::compressed_matrix< T, I >::reserve_row(), shark::blas::row(), shark::blas::compressed_matrix< T, I >::row_begin(), shark::blas::compressed_matrix< T, I >::row_capacity(), shark::blas::compressed_matrix< T, I >::row_end(), shark::blas::compressed_matrix< T, I >::size1(), and shark::blas::compressed_matrix< T, I >::values().

§ set_filled()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::set_filled ( size_type non_zeros )

inline

Definition at line 203 of file matrix_sparse.hpp.

§ set_row_filled()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::set_row_filled	(	size_type	i,
		size_type	non_zeros
	)

inline

Definition at line 207 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::row_capacity(), shark::blas::compressed_matrix< T, I >::size1(), and SIZE_CHECK.

§ size1()

template<class T , class I = std::size_t>

size_type shark::blas::compressed_matrix< T, I >::size1 ( ) const

inline

Definition at line 140 of file matrix_sparse.hpp.

§ size2()

template<class T , class I = std::size_t>

size_type shark::blas::compressed_matrix< T, I >::size2 ( ) const

inline

Definition at line 143 of file matrix_sparse.hpp.

Referenced by shark::blas::compressed_matrix< T, I >::operator()(), shark::blas::compressed_matrix< T, I >::operator=(), and shark::blas::compressed_matrix< T, I >::resize().

§ swap()

template<class T , class I = std::size_t>

void shark::blas::compressed_matrix< T, I >::swap ( compressed_matrix< T, I > & m )

inline

Definition at line 301 of file matrix_sparse.hpp.

References shark::swap().

Referenced by shark::blas::compressed_matrix< T, I >::operator=().

§ values() [1/2]

template<class T , class I = std::size_t>

value_type const* shark::blas::compressed_matrix< T, I >::values ( ) const

inline

Definition at line 176 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::nnz_capacity().

Referenced by shark::blas::compressed_matrix< T, I >::clear_range(), shark::blas::compressed_matrix< T, I >::reserve_row(), shark::blas::compressed_matrix< T, I >::row_begin(), shark::blas::compressed_matrix< T, I >::row_end(), and shark::blas::compressed_matrix< T, I >::set_element().

§ values() [2/2]

template<class T , class I = std::size_t>

value_type* shark::blas::compressed_matrix< T, I >::values ( )

inline

Definition at line 197 of file matrix_sparse.hpp.

References shark::blas::compressed_matrix< T, I >::nnz_capacity().

Friends And Related Function Documentation

§ swap

template<class T , class I = std::size_t>

void swap	(	compressed_matrix< T, I > &	m1,
		compressed_matrix< T, I > &	m2
	)

friend

Definition at line 311 of file matrix_sparse.hpp.

§ swap_rows [1/2]

template<class T , class I = std::size_t>

void swap_rows	(	compressed_matrix< T, I > &	a,
		size_type	i,
		compressed_matrix< T, I > &	b,
		size_type	j
	)

friend

Definition at line 315 of file matrix_sparse.hpp.

§ swap_rows [2/2]

template<class T , class I = std::size_t>

void swap_rows	(	compressed_matrix< T, I > &	a,
		size_type	i,
		size_type	j
	)

friend

Definition at line 352 of file matrix_sparse.hpp.

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

include/shark/LinAlg/BLAS/matrix_sparse.hpp

Classes

Public Types

Public Member Functions

Friends

Detailed Description

template<class T, class I = std::size_t> class shark::blas::compressed_matrix< T, I >

Member Typedef Documentation

§ column_iterator

§ const_column_iterator

§ const_index_pointer

§ const_pointer

§ const_reference

§ const_row_iterator

§ evaluation_category

§ index_pointer

§ orientation

§ pointer

§ row_iterator

§ storage_category

Constructor & Destructor Documentation

§ compressed_matrix() [1/3]

§ compressed_matrix() [2/3]

§ compressed_matrix() [3/3]

Member Function Documentation

§ clear()

§ clear_element()

§ clear_range()

§ inner_indices() [1/2]

§ inner_indices() [2/2]

§ inner_nnz()

§ nnz()

§ nnz_capacity()

§ operator()() [1/2]

§ operator()() [2/2]

§ operator=() [1/2]

§ operator=() [2/2]

§ outer_indices() [1/2]

§ outer_indices() [2/2]

§ outer_indices_end() [1/2]

§ outer_indices_end() [2/2]

§ reserve()

§ reserve_row()

§ resize()

§ row_begin() [1/2]

§ row_begin() [2/2]

§ row_capacity()

§ row_end() [1/2]

§ row_end() [2/2]

§ serialize()

§ set_element()

§ set_filled()

§ set_row_filled()

§ size1()

§ size2()

§ swap()

§ values() [1/2]

§ values() [2/2]

Friends And Related Function Documentation

§ swap

§ swap_rows [1/2]

§ swap_rows [2/2]

template<class T, class I = std::size_t>
class shark::blas::compressed_matrix< T, I >