Init & Finalize

Functions
int	ABT_init (int argc, char **argv)
	Initialize the Argobots execution environment. More...
int	ABT_finalize (void)
	Terminate the Argobots execution environment. More...
int	ABT_initialized (void)
	Check whether ABT_init() has been called. More...

Detailed Description

This group is for initialization and finalization of the Argobots environment.

Function Documentation

int ABT_finalize

(

void

)

Terminate the Argobots execution environment.

ABT_finalize() terminates the Argobots execution environment and deallocates memory internally used in Argobots. This function also contains deallocation of objects for the primary ES and the primary ULT.

ABT_finalize() must be called by the primary ULT. Invoking the Argobots functions after ABT_finalize() is not allowed. To use the Argobots functions after calling ABT_finalize(), ABT_init() needs to be called again.

Returns

Error code

Return values

ABT_SUCCESS

on success

Definition at line 135 of file global.c.

int ABT_init	(	int	argc,
		char **	argv
	)

Initialize the Argobots execution environment.

ABT_init() initializes the Argobots library and its execution environment. It internally creates objects for the primary ES and the primary ULT.

ABT_init() must be called by the primary ULT before using any other Argobots functions. ABT_init() can be called again after ABT_finalize() is called.

Parameters

[in]	argc	the number of arguments
[in]	argv	the argument vector

Returns

Error code

Return values

ABT_SUCCESS

on success

Definition at line 40 of file global.c.

int ABT_initialized

(

void

)

Check whether ABT_init() has been called.

ABT_initialized() returns ABT_SUCCESS if the Argobots execution environment has been initialized. Otherwise, it returns ABT_ERR_UNINITIALIZED.

Returns

Error code

Return values

ABT_SUCCESS	if the environment has been initialized.
ABT_ERR_UNINITIALIZED	if the environment has not been initialized.

Definition at line 239 of file global.c.