Useful for printing a table to the terminal or into a file. More...

#include <table.h>

Public Member Functions
void	add_cols (size_t num)

void	add_rows (size_t num)

void	clear ()

const T &	get (size_t rowInd, size_t colInd) const
	uses operator() to get a value More...

char	get_col_alignment (size_t col) const

char	get_col_sep (size_t col) const

char	get_row_sep (size_t row) const

size_t	num_cols () const

size_t	num_rows () const

T &	operator() (size_t rowInd, size_t colInd)
	Returns a reference to the given entry. More...

const T &	operator() (size_t rowInd, size_t colInd) const
	Returns a reference to the given entry. More...

void	set (size_t rowInd, size_t colInd, T value)
	uses operator() to set an entry to a value More...

void	set_col_alignment (size_t i_col, const char *c)

void	set_col_alignments (std::string s)

void	set_col_seperator (size_t i_col, const char *c)

void	set_col_seperators (std::string s)

void	set_default_col_alignment (const char *c)

void	set_default_col_seperator (const char *c)

void	set_default_row_seperator (const char *c)

void	set_row_seperator (size_t i_row, const char *c)

void	set_row_seperators (std::string s)

std::ostream &	stream (std::ostream &os) const

	Table ()

	Table (size_t numRows, size_t numCols)

std::string	to_csv (const char *seperator) const

std::string	to_latex () const

std::string	to_string () const

void	transpose ()

	~Table ()

Private Types
typedef std::vector< std::vector< T * > >	DataVec

Private Attributes
std::vector< char >	m_colAlign

std::vector< char >	m_colSep

DataVec	m_data

char	m_defaultColAlignment

char	m_defaultColSeperator

char	m_defaultRowSeperator

size_t	m_numCols

size_t	m_numRows

std::vector< char >	m_rowSep

Detailed Description

template<class T>
class ug::Table< T >

Useful for printing a table to the terminal or into a file.

This class is for output purposes only. It automatically adds spacings, so that all entries in a column are indeed displayed in the same column. Note that the implementation is not optimized in regards to speed and efficiency. The class thus shouldn't be used in performance critical sections of your code. If it is however used in output related code, the introduced overhead should be fine and probably even negligible.

The class is most commonly used as a string table (Table<std::string>) or as a stringstream table (Table<std::stringstream>). If you want to use it for your own types, you may specialize the template method

template <class T> std::string EntryToString(const Table<T>& table, size_t rowInd, size_t colInd);

ug::EntryToString

std::string EntryToString(const Table< T > &table, size_t rowInd, size_t colInd)

Returns a string-representation of the current entry.

Definition: table_impl.hpp:274

The default implementation of EntryToString may already be suited for most cases.

Here's an example on how to use the class:

#include "common/util/table.h"
...
ug::Table<std::stringstream> table;
table(0, 0) << "num rows:";   table(0, 1) << table.num_rows();
table(1, 0) << "num columns:";  table(1, 1) << table.num_cols();
std::cout << table;

And this is what the output looks like:

    num rows:  2
    num columns:  2
*

Note that several typedefs exist: StringTable, StringStreamTable

Todo:: different alignments for different columns / rows / fields

Member Typedef Documentation

◆ DataVec

template<class T >

typedef std::vector<std::vector<T*> > ug::Table< T >::DataVec

private

Constructor & Destructor Documentation

◆ Table() [1/2]

template<class T >

ug::Table< T >::Table

References ug::Table< T >::m_defaultColAlignment, ug::Table< T >::m_defaultColSeperator, and ug::Table< T >::m_defaultRowSeperator.

◆ Table() [2/2]

template<class T >

ug::Table< T >::Table	(	size_t	numRows,
		size_t	numCols
	)

References ug::Table< T >::add_cols(), ug::Table< T >::add_rows(), ug::Table< T >::m_defaultColAlignment, ug::Table< T >::m_defaultColSeperator, and ug::Table< T >::m_defaultRowSeperator.

◆ ~Table()

template<class T >

ug::Table< T >::~Table

Member Function Documentation

◆ add_cols()

template<class T >

void ug::Table< T >::add_cols ( size_t num )

Referenced by ug::Table< T >::Table().

◆ add_rows()

template<class T >

void ug::Table< T >::add_rows ( size_t num )

Referenced by ug::Table< T >::Table().

◆ clear()

template<class T >

void ug::Table< T >::clear

Referenced by ug::StringTableStream::clear(), and ug::StringTableStream::operator<<().

◆ get()

template<class T >

const T& ug::Table< T >::get	(	size_t	rowInd,
		size_t	colInd
	)		const

inline

uses operator() to get a value

References ug::Table< T >::operator()().

◆ get_col_alignment()

template<class T >

char ug::Table< T >::get_col_alignment ( size_t col ) const

inline

References ug::Table< T >::m_colAlign, and ug::Table< T >::m_defaultColAlignment.

◆ get_col_sep()

template<class T >

char ug::Table< T >::get_col_sep ( size_t col ) const

inline

References ug::Table< T >::m_colSep, and ug::Table< T >::m_defaultColSeperator.

◆ get_row_sep()

template<class T >

char ug::Table< T >::get_row_sep ( size_t row ) const

inline

References ug::Table< T >::m_defaultRowSeperator, and ug::Table< T >::m_rowSep.

◆ num_cols()

template<class T >

size_t ug::Table< T >::num_cols

Referenced by ug::LoadBalancer::print_last_quality_record().

◆ num_rows()

template<class T >

size_t ug::Table< T >::num_rows

Referenced by ug::LoadBalancer::create_quality_record(), and ug::LoadBalancer::print_last_quality_record().

◆ operator()() [1/2]

template<class T >

T & ug::Table< T >::operator()	(	size_t	rowInd,
		size_t	colInd
	)

Returns a reference to the given entry.

If an entry lies outside of the tables bounds, the table will automatically be resized accordingly.

Referenced by ug::Table< T >::get(), and ug::Table< T >::set().

◆ operator()() [2/2]

template<class T >

const T & ug::Table< T >::operator()	(	size_t	rowInd,
		size_t	colInd
	)		const

Returns a reference to the given entry.

References num_cols(), num_rows(), and UG_COND_THROW.

◆ set()

template<class T >

void ug::Table< T >::set	(	size_t	rowInd,
		size_t	colInd,
		T	value
	)

inline

uses operator() to set an entry to a value

References ug::Table< T >::operator()().

◆ set_col_alignment()

template<class T >

void ug::Table< T >::set_col_alignment	(	size_t	i_col,
		const char *	c
	)

inline

References ug::Table< T >::m_colAlign.

◆ set_col_alignments()

template<class T >

void ug::Table< T >::set_col_alignments ( std::string s )

inline

References ug::Table< T >::m_colAlign, and s.

◆ set_col_seperator()

template<class T >

void ug::Table< T >::set_col_seperator	(	size_t	i_col,
		const char *	c
	)

inline

References ug::Table< T >::m_colSep.

◆ set_col_seperators()

template<class T >

void ug::Table< T >::set_col_seperators ( std::string s )

inline

References ug::Table< T >::m_colSep, and s.

◆ set_default_col_alignment()

template<class T >

void ug::Table< T >::set_default_col_alignment ( const char * c )

inline

References ug::Table< T >::m_defaultColAlignment.

◆ set_default_col_seperator()

template<class T >

void ug::Table< T >::set_default_col_seperator ( const char * c )

inline

References ug::Table< T >::m_defaultColSeperator.

◆ set_default_row_seperator()

template<class T >

void ug::Table< T >::set_default_row_seperator ( const char * c )

inline

References ug::Table< T >::m_defaultRowSeperator.

◆ set_row_seperator()

template<class T >

void ug::Table< T >::set_row_seperator	(	size_t	i_row,
		const char *	c
	)

inline

References ug::Table< T >::m_rowSep.

◆ set_row_seperators()

template<class T >

void ug::Table< T >::set_row_seperators ( std::string s )

inline

References ug::Table< T >::m_rowSep, and s.

◆ stream()

template<class T >

std::ostream & ug::Table< T >::stream ( std::ostream & os ) const

References ug::EntryToString(), num_cols(), num_rows(), ug::repeat(), and s.

Referenced by ug::operator<<().

◆ to_csv()

template<typename T >

std::string ug::Table< T >::to_csv ( const char * seperator ) const

References ug::EntryToString(), num_cols(), and num_rows().

◆ to_latex()

template<typename T >

std::string ug::Table< T >::to_latex

References num_cols(), and num_rows().

◆ to_string()

template<class T >

std::string ug::Table< T >::to_string

Referenced by ug::AspectRatioInfo::to_string(), ug::StringTableStream::to_string(), ug::DomainInfo::to_string(), and ug::ProcessHierarchy::to_string().

◆ transpose()

template<class T >

void ug::Table< T >::transpose ( )

inline

References ug::Table< T >::m_data, ug::Table< T >::m_numCols, and ug::Table< T >::m_numRows.

Member Data Documentation

◆ m_colAlign

template<class T >

std::vector<char> ug::Table< T >::m_colAlign

private

Referenced by ug::Table< T >::get_col_alignment(), ug::Table< T >::set_col_alignment(), and ug::Table< T >::set_col_alignments().

◆ m_colSep

template<class T >

std::vector<char> ug::Table< T >::m_colSep

private

Referenced by ug::Table< T >::get_col_sep(), ug::Table< T >::set_col_seperator(), and ug::Table< T >::set_col_seperators().

◆ m_data

template<class T >

DataVec ug::Table< T >::m_data

private

Referenced by ug::Table< T >::transpose().

◆ m_defaultColAlignment

template<class T >

char ug::Table< T >::m_defaultColAlignment

private

Referenced by ug::Table< T >::get_col_alignment(), ug::Table< T >::set_default_col_alignment(), and ug::Table< T >::Table().

◆ m_defaultColSeperator

template<class T >

char ug::Table< T >::m_defaultColSeperator

private

Referenced by ug::Table< T >::get_col_sep(), ug::Table< T >::set_default_col_seperator(), and ug::Table< T >::Table().

◆ m_defaultRowSeperator

template<class T >

char ug::Table< T >::m_defaultRowSeperator

private

Referenced by ug::Table< T >::get_row_sep(), ug::Table< T >::set_default_row_seperator(), and ug::Table< T >::Table().

◆ m_numCols

template<class T >

size_t ug::Table< T >::m_numCols

private

Referenced by ug::Table< T >::transpose().

◆ m_numRows

template<class T >

size_t ug::Table< T >::m_numRows

private

Referenced by ug::Table< T >::transpose().

◆ m_rowSep

template<class T >

std::vector<char> ug::Table< T >::m_rowSep

private

Referenced by ug::Table< T >::get_row_sep(), ug::Table< T >::set_row_seperator(), and ug::Table< T >::set_row_seperators().

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

ugbase/common/util/table.h
ugbase/common/util/table_impl.hpp

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<class T> class ug::Table< T >

Member Typedef Documentation

◆ DataVec

Constructor & Destructor Documentation

◆ Table() [1/2]

◆ Table() [2/2]

◆ ~Table()

Member Function Documentation

◆ add_cols()

◆ add_rows()

◆ clear()

◆ get()

◆ get_col_alignment()

◆ get_col_sep()

◆ get_row_sep()

◆ num_cols()

◆ num_rows()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ set()

◆ set_col_alignment()

◆ set_col_alignments()

◆ set_col_seperator()

◆ set_col_seperators()

◆ set_default_col_alignment()

◆ set_default_col_seperator()

◆ set_default_row_seperator()

◆ set_row_seperator()

◆ set_row_seperators()

◆ stream()

◆ to_csv()

◆ to_latex()

◆ to_string()

◆ transpose()

Member Data Documentation

◆ m_colAlign

◆ m_colSep

◆ m_data

◆ m_defaultColAlignment

◆ m_defaultColSeperator

◆ m_defaultRowSeperator

◆ m_numCols

◆ m_numRows

◆ m_rowSep

template<class T>
class ug::Table< T >