Macros

Collaboration diagram for Macros:

Macros
#define	BITPIT_COMMA   ,
#define	BITPIT_CREATE_WORKSPACE(workspace, item_type, size, stack_size)
#define	BITPIT_DEPRECATED(func)   func
#define	BITPIT_UNREACHABLE(str)   assert(!str)
#define	BITPIT_UNUSED(variable)

Detailed Description

Macro Definition Documentation

BITPIT_COMMA

#define BITPIT_COMMA   ,

Comma.

Definition at line 97 of file compiler.hpp.

BITPIT_CREATE_WORKSPACE

#define BITPIT_CREATE_WORKSPACE	(		workspace,
			item_type,
			size,
			stack_size )

Value:

item_type *workspace;                                            \
std::array<item_type, stack_size> workspace##_stack;             \
std::unique_ptr<std::vector<item_type>> workspace##_heap;        \
if (size <= stack_size) {                                        \
    workspace = workspace##_stack.data();                        \
} else {                                                         \
    workspace##_heap = std::unique_ptr<std::vector<item_type>>(new std::vector<item_type>(size)); \
    workspace = workspace##_heap->data();                        \
}

Create a workspace with the specified size.

If the size is less than the specified stack size, the workspace will make use of an array created on the stack, otherwise a container with the specified size will be created on the heap and that container will be used for the workspace.

NOTE: this macro will always create an array on the stack, whether it will be used as workspace or not depend on the requested workspace size.

Parameters

workspace	is the name of the workspace
item_type	is the type of items the workspace will contain
size	is the size of the workspace
stack_size	is the maximum size the workspace can have to be allocated on the stack

Examples

RBF_example_00001.cpp.

Definition at line 76 of file commonUtils.hpp.

BITPIT_DEPRECATED

#define BITPIT_DEPRECATED

(

func

)

func

Deprecated macro.

Parameters

func	id the function/method to be marked as deprecated

Definition at line 87 of file compiler.hpp.

BITPIT_UNREACHABLE

#define BITPIT_UNREACHABLE

(

str

)

assert(!str)

Unreachable macro.

Useful for suppressing "control reaches end of non-void function" warnings.

Parameters

str	is the error message that will be displayed it the unreachable code is reached

Definition at line 53 of file compiler.hpp.

BITPIT_UNUSED

#define BITPIT_UNUSED

(

variable

)

Value:

do {                  \
    (void)(variable); \
} while (0)

Unused macro.

Parameters

variable

is the name of variable to be marked as unused

Examples

LA_example_00001.cpp, PABLO_bubbles_2D.cpp, PABLO_bubbles_3D.cpp, PABLO_example_00001.cpp, PABLO_example_00002.cpp, PABLO_example_00003.cpp, PABLO_example_00004.cpp, PABLO_example_00005.cpp, PABLO_example_00006.cpp, PABLO_example_00007.cpp, PABLO_example_00008.cpp, PABLO_example_00009.cpp, PABLO_example_00010.cpp, PABLO_example_00011.cpp, POD_application_example_00001.cpp, patchkernel_example_00001.cpp, and voloctree_adaptation_example_00001.cpp.

Definition at line 63 of file compiler.hpp.