label.H File Reference

Include dependency graph for label.H:

Go to the source code of this file.

Classes
struct	labelOp< class >
	Conversion/extraction to label operation. More...
struct	labelOp< int32_t >
	Convert (likely promote) from int32_t to label. More...
struct	labelOp< int64_t >
	Convert (possibly truncate) from int64_t to label. More...

Namespaces
	Foam
	Namespace for OpenFOAM.

Macros
#define	INT_ADD_SIZE(x, s, y)   x ## s ## y
#define	INT_ADD_DEF_SIZE(x, s, y)   INT_ADD_SIZE(x,s,y)
#define	INT_SIZE(x, y)   INT_ADD_DEF_SIZE(x,WM_LABEL_SIZE,y)

Functions
label	readLabel (const char *buf)
	Parse entire buffer as a label, skipping leading/trailing whitespace. More...
label	readLabel (const std::string &str)
	Parse entire string as a label, skipping leading/trailing whitespace. More...
bool	readLabel (const char *buf, label &val)
	Parse entire buffer as a label, skipping leading/trailing whitespace. More...
bool	readLabel (const std::string &str, label &val)
	Parse entire string as a label, skipping leading/trailing whitespace. More...
label	readLabel (Istream &is)
	Read label from stream. More...
label	readRawLabel (Istream &is)
	Read raw label from binary stream. More...
void	readRawLabel (Istream &is, label *data, size_t nElem=1)
	Read raw label(s) from binary stream. More...
label	pow (label a, label b)
	Raise one label to the power of another. More...
label	factorial (label n)
	Evaluate n! : 0 < n <= 12. More...
label &	setComponent (label &val, const direction) noexcept
	Non-const access to integer-type (has no components) More...
constexpr label	component (const label val, const direction) noexcept
	Return integer value (has no components) More...
template<class T >
bool	equal (const T &a, const T &b)
	Compare two values for equality. More...
template<class T >
T	clamp (const T &val, const T &lower, const T &upper)
	Return value clamped between upper and lower limits. More...
int32_t	narrowInt32 (const int64_t val)
	Type narrowing from int64_t to int32_t. More...

Variables
constexpr label	labelMin = INTWM_LABEL_SIZE_MIN
constexpr label	labelMax = INTWM_LABEL_SIZE_MAX

Detailed Description

Original source file label.H

Definition in file label.H.

Macro Definition Documentation

INT_ADD_SIZE

#define INT_ADD_SIZE	(		x,
			s,
			y
	)		x ## s ## y

Definition at line 41 of file label.H.

INT_ADD_DEF_SIZE

#define INT_ADD_DEF_SIZE	(		x,
			s,
			y
	)		INT_ADD_SIZE(x,s,y)

Definition at line 42 of file label.H.

INT_SIZE

#define INT_SIZE	(		x,
			y
	)		INT_ADD_DEF_SIZE(x,WM_LABEL_SIZE,y)

Definition at line 43 of file label.H.

Referenced by Foam::readLabel().