librpa Namespace Reference

librpa Namespace Reference#

LibRPA: librpa Namespace Reference

LibRPA

Main namespace for LibRPA C++ API. More...

Classes
class	Handler
	Main handler class for LibRPA computations. More...

class	Options
	C++ wrapper for runtime options. More...

Typedefs
typedef LibrpaParallelRouting	ParallelRouting
	Parallel routing strategy (C++ alias).

typedef LibrpaTimeFreqGrid	TimeFreqGrid
	Time/frequency grid type (C++ alias)

typedef LibrpaSwitch	Switch
	Boolean switch type (C++ alias)

typedef LibrpaKind	Kind
	DFT code kind type (C++ alias, reserved)

typedef LibrpaVerbose	Verbose
	Verbosity level type (C++ alias)

Functions
const char *	get_build_info (void)
	Get build information string.

int	get_major_version (void)
	Get major version number.

int	get_minor_version (void)
	Get minor version number.

int	get_patch_version (void)
	Get patch version number.

void	init_global (Switch switch_redirect_stdout=LIBRPA_SWITCH_OFF, const char *redirect_path="stdout", Switch switch_process_output=LIBRPA_SWITCH_ON)
	Initialize the global LibRPA environment.

void	finalize_global (void)
	Finalize the global LibRPA environment.

void	test (void)
	Run internal self-tests.

void	print_profile (void)
	Print profiling information.

Detailed Description

Main namespace for LibRPA C++ API.

Typedef Documentation

◆ ParallelRouting

typedef LibrpaParallelRouting librpa::ParallelRouting

Parallel routing strategy (C++ alias).

See also: LibrpaParallelRouting

Function Documentation

◆ finalize_global()

void librpa::finalize_global ( void )

Finalize the global LibRPA environment.

Must be called after all LibRPA operations are complete.

See also: librpa_finalize_global

◆ get_build_info()

const char * librpa::get_build_info ( void )

Get build information string.

Returns: C-string containing build information.

See also: librpa_get_build_info

◆ get_major_version()

int librpa::get_major_version ( void )

Get major version number.

Returns: Major version (X in X.Y.Z).

See also: librpa_get_major_version

◆ get_minor_version()

int librpa::get_minor_version ( void )

Get minor version number.

Returns: Minor version (Y in X.Y.Z).

See also: librpa_get_minor_version

◆ get_patch_version()

int librpa::get_patch_version ( void )

Get patch version number.

Returns: Patch version (Z in X.Y.Z).

See also: librpa_get_patch_version

◆ init_global()

void librpa::init_global	(	Switch	switch_redirect_stdout = LIBRPA_SWITCH_OFF,
		const char *	redirect_path = "stdout",
		Switch	switch_process_output = LIBRPA_SWITCH_ON )

Initialize the global LibRPA environment.

Must be called after MPI_Init() and before any other LibRPA functions.

Parameters

switch_redirect_stdout	If true, redirect stdout to a file.
redirect_path	Path for redirected output (default: "stdout").
switch_process_output	If true, enable per-process output (default: true).

See also: librpa_init_global

◆ print_profile()

void librpa::print_profile ( void )

Print profiling information.

See also: librpa_print_profile

◆ test()

void librpa::test ( void )

Run internal self-tests.

See also: librpa_test