Reference documentation for deal.II version Git e512aac53a 2019-11-15 17:29:53 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Public Attributes | List of all members
TableHandler::Column Struct Reference

#include <deal.II/base/table_handler.h>

Public Member Functions

 Column ()
 
 Column (const std::string &tex_caption)
 
void pad_column_below (const unsigned int length)
 
template<class Archive >
void save (Archive &ar, const unsigned int version) const
 
void invalidate_cache ()
 

Public Attributes

std::vector< internal::TableEntryentries
 
std::string tex_caption
 
std::string tex_format
 
unsigned int precision
 
bool scientific
 
unsigned int flag
 
unsigned int max_length
 

Detailed Description

Structure encapsulating all the data that is needed to describe one column of a table.

Definition at line 613 of file table_handler.h.

Constructor & Destructor Documentation

◆ Column() [1/2]

TableHandler::Column::Column ( )

Constructor needed by std::map.

Definition at line 147 of file table_handler.cc.

◆ Column() [2/2]

TableHandler::Column::Column ( const std::string &  tex_caption)

Constructor.

Definition at line 136 of file table_handler.cc.

Member Function Documentation

◆ pad_column_below()

void TableHandler::Column::pad_column_below ( const unsigned int  length)

Pad this column with default constructed elements to the number of rows given by the argument.

Definition at line 159 of file table_handler.cc.

◆ save()

template<class Archive >
void TableHandler::Column::save ( Archive &  ar,
const unsigned int  version 
) const

Read or write the data of this object to or from a stream for the purpose of serialization.

Definition at line 948 of file table_handler.h.

◆ invalidate_cache()

void TableHandler::Column::invalidate_cache ( )

Invalidates the string cache of all the entries and recomputes the maximum length max_length.

Definition at line 179 of file table_handler.cc.

Member Data Documentation

◆ entries

std::vector<internal::TableEntry> TableHandler::Column::entries

List of entries within this column. Values are always immediately converted to strings to provide a uniform method of lookup.

Definition at line 656 of file table_handler.h.

◆ tex_caption

std::string TableHandler::Column::tex_caption

The caption of the column in tex output. By default, this is the key string that is given to the TableHandler by TableHandler::add_value(...). This may be changed by calling TableHandler::set_tex_caption(...).

Definition at line 664 of file table_handler.h.

◆ tex_format

std::string TableHandler::Column::tex_format

The column format in tex output. By default, this is "c", meaning `centered'. This may be changed by calling TableHandler::set_tex_format(...) with "c", "r", "l" for centered, right or left.

Definition at line 673 of file table_handler.h.

◆ precision

unsigned int TableHandler::Column::precision

Double or float entries are written with this precision (set by the user). The default is 4.

Definition at line 679 of file table_handler.h.

◆ scientific

bool TableHandler::Column::scientific

scientific=false means fixed point notation.

Definition at line 684 of file table_handler.h.

◆ flag

unsigned int TableHandler::Column::flag

Flag that may be used by derived classes for arbitrary purposes.

In particular, the ConvergenceTable class uses the flag to denote columns for which convergence information has already been computed, or should not be computed at all.

Definition at line 693 of file table_handler.h.

◆ max_length

unsigned int TableHandler::Column::max_length

This entry caches the maximum length in characters for all entries in this table.

Definition at line 699 of file table_handler.h.


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