Reference documentation for deal.II version GIT relicensing-384-g4769914377 2024-04-13 09:00:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | Static Private Attributes | List of all members
Patterns::List Class Reference

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

Inheritance diagram for Patterns::List:
Inheritance graph

Public Types

enum  OutputStyle { Machine , Text , LaTeX }

Public Member Functions

 List (const PatternBase &base_pattern, const unsigned int min_elements=0, const unsigned int max_elements=max_int_value, const std::string &separator=",")
const std::string & get_separator () const
const PatternBaseget_base_pattern () const
 List (const List &other)
virtual bool match (const std::string &test_string) const override
virtual std::string description (const OutputStyle style=Machine) const override
virtual std::unique_ptr< PatternBaseclone () const override
std::size_t memory_consumption () const override

Static Public Member Functions

static std::unique_ptr< Listcreate (const std::string &description)
static ::ExceptionBaseExcInvalidRange (int arg1, int arg2)

Static Public Attributes

static const unsigned int max_int_value

Private Attributes

std::unique_ptr< PatternBasepattern
const unsigned int min_elements
const unsigned int max_elements
const std::string separator

Static Private Attributes

static const char * description_init = "[List"

Detailed Description

This pattern matches a list of values separated by commas (or another string), each of which have to match a pattern given to the constructor. With two additional parameters, the number of elements this list has to have can be specified. If none is specified, the list may have zero or more entries.

Definition at line 448 of file patterns.h.

Member Enumeration Documentation

◆ OutputStyle

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.


Simple text suitable for machine parsing in the static public member functions for all of the built in inheriting classes.

Preferably human readable, but machine parsing is more critical.


Easily human readable plain text format suitable for plain text documentation.


Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 96 of file patterns.h.

Constructor & Destructor Documentation

◆ List() [1/2]

Patterns::List::List ( const PatternBase base_pattern,
const unsigned int  min_elements = 0,
const unsigned int  max_elements = max_int_value,
const std::string &  separator = "," 

Constructor. Take the given parameter as the specification of valid elements of the list.

The three other arguments can be used to denote minimal and maximal allowable lengths of the list, and the string that is used as a separator between elements of the list.

Definition at line 651 of file

◆ List() [2/2]

Patterns::List::List ( const List other)

Copy constructor.

Definition at line 668 of file

Member Function Documentation

◆ get_separator()

const std::string & Patterns::List::get_separator ( ) const

Return the internally stored separator.

Definition at line 677 of file

◆ get_base_pattern()

const PatternBase & Patterns::List::get_base_pattern ( ) const

Return the internally stored base pattern.

Definition at line 685 of file

◆ match()

bool Patterns::List::match ( const std::string &  test_string) const

Return true if the string is a comma-separated list of strings each of which match the pattern given to the constructor.

Implements Patterns::PatternBase.

Definition at line 693 of file

◆ description()

std::string Patterns::List::description ( const OutputStyle  style = Machine) const

Return a description of the pattern that valid strings are expected to match.

Implements Patterns::PatternBase.

Definition at line 713 of file

◆ clone()

std::unique_ptr< PatternBase > Patterns::List::clone ( ) const

Return a copy of the present object, which is newly allocated on the heap. Ownership of that object is transferred to the caller of this function.

Implements Patterns::PatternBase.

Definition at line 757 of file

◆ create()

std::unique_ptr< List > Patterns::List::create ( const std::string &  description)

Create a new object if the start of description matches description_init. Ownership of that object is transferred to the caller of this function.

Definition at line 774 of file

◆ memory_consumption()

std::size_t Patterns::List::memory_consumption ( ) const

Determine an estimate for the memory consumption (in bytes) of this object.

Reimplemented from Patterns::PatternBase.

Definition at line 765 of file

Member Data Documentation

◆ max_int_value

const unsigned int Patterns::List::max_int_value
Initial value:
std::numeric_limits<unsigned int>::max()

Maximal integer value. If the numeric_limits class is available use this information to obtain the extremal values, otherwise set it so that this class understands that all values are allowed.

Definition at line 456 of file patterns.h.

◆ pattern

std::unique_ptr<PatternBase> Patterns::List::pattern

Copy of the pattern that each element of the list has to satisfy.

Definition at line 544 of file patterns.h.

◆ min_elements

const unsigned int Patterns::List::min_elements

Minimum number of elements the list must have.

Definition at line 549 of file patterns.h.

◆ max_elements

const unsigned int Patterns::List::max_elements

Maximum number of elements the list must have.

Definition at line 554 of file patterns.h.

◆ separator

const std::string Patterns::List::separator

Separator between elements of the list.

Definition at line 559 of file patterns.h.

◆ description_init

const char * Patterns::List::description_init = "[List"

Initial part of description

Definition at line 564 of file patterns.h.

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