Reference documentation for deal.II version GIT relicensing-1291-gf3a46e514e 2024-07-24 11:20: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 | Private Attributes | Static Private Attributes | List of all members
Patterns::Selection Class Reference

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

Inheritance diagram for Patterns::Selection:
Inheritance graph

Public Types

enum  OutputStyle { Machine , Text , LaTeX }

Public Member Functions

 Selection (const std::string &seq)
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< Selectioncreate (const std::string &description)

Private Attributes

std::string sequence

Static Private Attributes

static const char * description_init = "[Selection"

Detailed Description

Test for the string being one of a sequence of values given like a regular expression. For example, if the string given to the constructor is "red|blue|black", then the match function returns true exactly if the string is either "red" or "blue" or "black". Spaces around the pipe signs do not matter and are eliminated.

Definition at line 380 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

◆ Selection()

Patterns::Selection::Selection ( const std::string &  seq)

Constructor. Take the given parameter as the specification of valid strings.

Definition at line 531 of file

Member Function Documentation

◆ match()

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

Return true if the string is an element of the description list passed to the constructor.

Implements Patterns::PatternBase.

Definition at line 543 of file

◆ description()

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

Return a description of the pattern that valid strings are expected to match. Here, this is the list of valid strings passed to the constructor.

Implements Patterns::PatternBase.

Reimplemented in Patterns::Bool.

Definition at line 575 of file

◆ clone()

std::unique_ptr< PatternBase > Patterns::Selection::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.

Reimplemented in Patterns::Bool.

Definition at line 610 of file

◆ memory_consumption()

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

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

Reimplemented from Patterns::PatternBase.

Definition at line 617 of file

◆ create()

std::unique_ptr< Selection > Patterns::Selection::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 626 of file

Member Data Documentation

◆ sequence

std::string Patterns::Selection::sequence

List of valid strings as passed to the constructor. We don't make this string constant, as we process it somewhat in the constructor.

Definition at line 432 of file patterns.h.

◆ description_init

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

Initial part of description

Definition at line 437 of file patterns.h.

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