#include <SparseTable.hpp>

Inheritance diagram for Opm::SparseTable< T >:

Classes
class	Iterator

Public Types
using	row_type = iterator_range< typename std::vector< T >::const_iterator >
	Defining the row type, returned by operator[]. More...

using	mutable_row_type = mutable_iterator_range< typename std::vector< T >::iterator >

Public Member Functions
	SparseTable ()
	Default constructor. Yields an empty SparseTable. More...

template<typename DataIter , typename IntegerIter >
	SparseTable (DataIter data_beg, DataIter data_end, IntegerIter rowsize_beg, IntegerIter rowsize_end)

template<typename DataIter , typename IntegerIter >
void	assign (DataIter data_beg, DataIter data_end, IntegerIter rowsize_beg, IntegerIter rowsize_end)

template<typename IntegerIter >
void	allocate (IntegerIter rowsize_beg, IntegerIter rowsize_end)

template<typename DataIter >
void	appendRow (DataIter row_beg, DataIter row_end)
	Appends a row to the table. More...

bool	empty () const
	True if the table contains no rows. More...

int	size () const
	Returns the number of rows in the table. More...

void	reserve (int exptd_nrows, int exptd_ndata)
	Allocate storage for table of expected size. More...

void	swap (SparseTable< T > &other)
	Swap contents for other SparseTable<T> More...

int	dataSize () const
	Returns the number of data elements. More...

int	rowSize (int row) const
	Returns the size of a table row. More...

void	clear ()
	Makes the table empty(). More...

row_type	operator[] (int row) const
	Returns a row of the table. More...

mutable_row_type	operator[] (int row)
	Returns a mutable row of the table. More...

Iterator	begin () const
	Iterator access. More...

Iterator	end () const

bool	operator== (const SparseTable &other) const
	Equality. More...

template<class charT , class traits >
void	print (std::basic_ostream< charT, traits > &os) const

const T	data (int i) const

Detailed Description

template<typename T>
class Opm::SparseTable< T >

A SparseTable stores a table with rows of varying size as efficiently as possible. It is supposed to behave similarly to a vector of vectors. Its behaviour is similar to compressed row sparse matrices.

Member Typedef Documentation

◆ mutable_row_type

template<typename T >

using Opm::SparseTable< T >::mutable_row_type = mutable_iterator_range<typename std::vector<T>::iterator>

◆ row_type

template<typename T >

using Opm::SparseTable< T >::row_type = iterator_range<typename std::vector<T>::const_iterator>

Defining the row type, returned by operator[].

Constructor & Destructor Documentation

◆ SparseTable() [1/2]

template<typename T >

Opm::SparseTable< T >::SparseTable ( )

inline

Default constructor. Yields an empty SparseTable.

◆ SparseTable() [2/2]

template<typename T >

template<typename DataIter , typename IntegerIter >

Opm::SparseTable< T >::SparseTable	(	DataIter	data_beg,
		DataIter	data_end,
		IntegerIter	rowsize_beg,
		IntegerIter	rowsize_end
	)

inline

A constructor taking all the data for the table and row sizes.

Parameters

data_beg	The start of the table data.
data_end	One-beyond-end of the table data.
rowsize_beg	The start of the row length data.
rowsize_end	One beyond the end of the row length data.

Member Function Documentation

◆ allocate()

template<typename T >

template<typename IntegerIter >

void Opm::SparseTable< T >::allocate	(	IntegerIter	rowsize_beg,
		IntegerIter	rowsize_end
	)

inline

Request storage for table of given size.

Parameters

rowsize_beg	Start of row size data.
rowsize_end	One beyond end of row size data.

◆ appendRow()

template<typename T >

template<typename DataIter >

void Opm::SparseTable< T >::appendRow	(	DataIter	row_beg,
		DataIter	row_end
	)

inline

Appends a row to the table.

Referenced by Dune::cpgrid::Geometry< 3, cdim >::refineCellifiedPatch().

◆ assign()

template<typename T >

template<typename DataIter , typename IntegerIter >

void Opm::SparseTable< T >::assign	(	DataIter	data_beg,
		DataIter	data_end,
		IntegerIter	rowsize_beg,
		IntegerIter	rowsize_end
	)

inline

Sets the table to contain the given data, organized into rows as indicated by the given row sizes.

Parameters

data_beg	The start of the table data.
data_end	One-beyond-end of the table data.
rowsize_beg	The start of the row length data.
rowsize_end	One beyond the end of the row length data.

◆ begin()

template<typename T >

Iterator Opm::SparseTable< T >::begin ( ) const

inline

Iterator access.

◆ clear()

template<typename T >

void Opm::SparseTable< T >::clear ( )

inline

Makes the table empty().

◆ data()

template<typename T >

const T Opm::SparseTable< T >::data ( int i ) const

inline

◆ dataSize()

template<typename T >

int Opm::SparseTable< T >::dataSize ( ) const

inline

Returns the number of data elements.

◆ empty()

template<typename T >

bool Opm::SparseTable< T >::empty ( ) const

inline

True if the table contains no rows.

◆ end()

template<typename T >

Iterator Opm::SparseTable< T >::end ( ) const

inline

References Opm::SparseTable< T >::size().

◆ operator==()

template<typename T >

bool Opm::SparseTable< T >::operator== ( const SparseTable< T > & other ) const

inline

Equality.

Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::operator==().

◆ operator[]() [1/2]

template<typename T >

mutable_row_type Opm::SparseTable< T >::operator[] ( int row )

inline

Returns a mutable row of the table.

◆ operator[]() [2/2]

template<typename T >

row_type Opm::SparseTable< T >::operator[] ( int row ) const

inline

Returns a row of the table.

References Opm::SparseTable< T >::size().

Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::row().

◆ print()

template<typename T >

template<class charT , class traits >

void Opm::SparseTable< T >::print ( std::basic_ostream< charT, traits > & os ) const

inline

References Opm::SparseTable< T >::size().

◆ reserve()

template<typename T >

void Opm::SparseTable< T >::reserve	(	int	exptd_nrows,
		int	exptd_ndata
	)

inline

Allocate storage for table of expected size.

◆ rowSize()

template<typename T >

int Opm::SparseTable< T >::rowSize ( int row ) const

inline

Returns the size of a table row.

References Opm::SparseTable< T >::size().

Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::rowSize().

◆ size()

template<typename T >

int Opm::SparseTable< T >::size ( ) const

inline

Returns the number of rows in the table.

Referenced by Dune::cpgrid::OrientedEntityTable< 0, 1 >::allocate(), Opm::SparseTable< T >::end(), Opm::SparseTable< T >::operator[](), Opm::SparseTable< T >::print(), and Opm::SparseTable< T >::rowSize().

◆ swap()

template<typename T >

void Opm::SparseTable< T >::swap ( SparseTable< T > & other )

inline

Swap contents for other SparseTable<T>

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

SparseTable.hpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ mutable_row_type

◆ row_type

Constructor & Destructor Documentation

◆ SparseTable() [1/2]

◆ SparseTable() [2/2]

Member Function Documentation

◆ allocate()

◆ appendRow()

◆ assign()

◆ begin()

◆ clear()

◆ data()

◆ dataSize()

◆ empty()

◆ end()

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ print()

◆ reserve()

◆ rowSize()

◆ size()

◆ swap()