Reference documentation for deal.II version Git e038590ef8 2020-10-28 14:38:53 +0100
\(\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\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Static Private Attributes | List of all members
Patterns::Anything Class Reference

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

Inheritance diagram for Patterns::Anything:
[legend]

Public Types

enum  OutputStyle { Machine, Text, LaTeX }
 

Public Member Functions

 Anything ()=default
 
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
 
virtual std::size_t memory_consumption () const
 

Static Public Member Functions

static std::unique_ptr< Anythingcreate (const std::string &description)
 

Static Private Attributes

static const char * description_init = "[Anything"
 

Detailed Description

Always returns true when testing a string.

Definition at line 1022 of file patterns.h.

Member Enumeration Documentation

◆ OutputStyle

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.

Enumerator
Machine 

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.

Text 

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

LaTeX 

Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 98 of file patterns.h.

Constructor & Destructor Documentation

◆ Anything()

Patterns::Anything::Anything ( )
default

Constructor. (Allow for at least one non-virtual function in this class, as otherwise sometimes no virtual table is emitted.)

Member Function Documentation

◆ match()

bool Patterns::Anything::match ( const std::string &  test_string) const
overridevirtual

Return true if the string matches its constraints, i.e. always.

Implements Patterns::PatternBase.

Definition at line 1452 of file patterns.cc.

◆ description()

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

Return a description of the pattern that valid strings are expected to match. Here, this is the string "[Anything]".

Implements Patterns::PatternBase.

Definition at line 1460 of file patterns.cc.

◆ clone()

std::unique_ptr< PatternBase > Patterns::Anything::clone ( ) const
overridevirtual

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 1488 of file patterns.cc.

◆ create()

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

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 1496 of file patterns.cc.

◆ memory_consumption()

std::size_t Patterns::PatternBase::memory_consumption ( ) const
virtualinherited

Determine an estimate for the memory consumption (in bytes) of this object. To avoid unnecessary overhead, we do not force derived classes to provide this function as a virtual overloaded one, but rather try to cast the present object to one of the known derived classes and if that fails then take the size of this base class instead and add 32 byte (this value is arbitrary, it should account for virtual function tables, and some possible data elements). Since there are usually not many thousands of objects of this type around, and since the memory_consumption mechanism is used to find out where memory in the range of many megabytes is, this seems like a reasonable approximation.

On the other hand, if you know that your class deviates from this assumption significantly, you can still overload this function.

Reimplemented in Patterns::MultipleSelection, Patterns::Tuple, Patterns::Map, Patterns::List, and Patterns::Selection.

Definition at line 192 of file patterns.cc.

Member Data Documentation

◆ description_init

const char * Patterns::Anything::description_init = "[Anything"
staticprivate

Initial part of description

Definition at line 1065 of file patterns.h.


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