Patterns::Integer Class Reference

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

Inheritance diagram for Patterns::Integer:

Public Member Functions
	Integer (const int lower_bound=min_int_value, const int upper_bound=max_int_value)
virtual bool	match (const std::string &test_string) const
virtual std::string	description (const OutputStyle style=Machine) const
virtual PatternBase *	clone () const
Public Member Functions inherited from Patterns::PatternBase
virtual	~PatternBase ()
virtual std::size_t	memory_consumption () const

Static Public Member Functions
static Integer *	create (const std::string &description)

Static Public Attributes
static const int	min_int_value = std::numeric_limits<int>::min()
static const int	max_int_value = std::numeric_limits<int>::max()

Private Attributes
const int	lower_bound
const int	upper_bound

Static Private Attributes
static const char *	description_init = "[Integer"

Additional Inherited Members
Public Types inherited from Patterns::PatternBase
enum	OutputStyle { Machine, Text, LaTeX }

Detailed Description

Test for the string being an integer. If bounds are given to the constructor, then the integer given also needs to be within the interval specified by these bounds. Note that unlike common convention in the C++ standard library, both bounds of this interval are inclusive; the reason is that in practice in most cases, one needs closed intervals, but these can only be realized with inclusive bounds for non-integer values. We thus stay consistent by always using closed intervals.

If the upper bound given to the constructor is smaller than the lower bound, then every integer is allowed.

Giving bounds may be useful if for example a value can only be positive and less than a reasonable upper bound (for example the number of refinement steps to be performed), or in many other cases.

Definition at line 150 of file parameter_handler.h.

Constructor & Destructor Documentation

Integer()

Patterns::Integer::Integer	(	const int	lower_bound = min_int_value,
		const int	upper_bound = max_int_value
	)

Constructor. Bounds can be specified within which a valid parameter has to be. If the upper bound is smaller than the lower bound, then the entire set of integers is implied. The default values are chosen such that no bounds are enforced on parameters.

Definition at line 150 of file parameter_handler.cc.

Member Function Documentation

match()

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

virtual

Return true if the string is an integer and its value is within the specified range.

Implements Patterns::PatternBase.

Definition at line 159 of file parameter_handler.cc.

description()

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

virtual

Return a description of the pattern that valid strings are expected to match. If bounds were specified to the constructor, then include them into this description.

Implements Patterns::PatternBase.

Definition at line 181 of file parameter_handler.cc.

clone()

PatternBase * Patterns::Integer::clone ( ) const

virtual

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 245 of file parameter_handler.cc.

create()

Integer * Patterns::Integer::create ( const std::string &  description )

static

Creates 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 252 of file parameter_handler.cc.

Member Data Documentation

min_int_value

const int Patterns::Integer::min_int_value = std::numeric_limits<int>::min()

static

Minimal 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 158 of file parameter_handler.h.

max_int_value

const int Patterns::Integer::max_int_value = std::numeric_limits<int>::max()

static

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 165 of file parameter_handler.h.

lower_bound

const int Patterns::Integer::lower_bound

private

Value of the lower bound. A number that satisfies the match operation of this class must be equal to this value or larger, if the bounds of the interval for a valid range.

Definition at line 211 of file parameter_handler.h.

upper_bound

const int Patterns::Integer::upper_bound

private

Value of the upper bound. A number that satisfies the match operation of this class must be equal to this value or less, if the bounds of the interval for a valid range.

Definition at line 219 of file parameter_handler.h.

description_init

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

staticprivate

Initial part of description

Definition at line 224 of file parameter_handler.h.

---

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

• deal.II/base/parameter_handler.h
• source/base/parameter_handler.cc