librpa_global.h File Reference

librpa_global.h File Reference#

LibRPA: librpa_global.h File Reference

LibRPA

include

Global functions for LibRPA. More...

#include "librpa_enums.h"

Include dependency graph for librpa_global.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

int	librpa_get_major_version (void)
	Get major version number.

int	librpa_get_minor_version (void)
	Get minor version number.

int	librpa_get_patch_version (void)
	Get patch version number.

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

void	librpa_finalize_global (void)
	Finalize the global LibRPA environment.

void	librpa_test (void)
	Run internal self-tests.

void	librpa_print_profile (void)
	Print profiling information.

Detailed Description

Global functions for LibRPA.

These functions include:

initialization and finalization of the global LibRPA environment,
version check,
output of profiling statistics,
sanity check test function for debug use (librpa_test).

Global functions do not require initialization before hand.

Function Documentation

◆ librpa_finalize_global()

void librpa_finalize_global ( void )

Finalize the global LibRPA environment.

Must be called after all LibRPA operations are complete and before MPI_Finalize(). Releases all global resources.

◆ librpa_get_build_info()

const char * librpa_get_build_info ( void )

Get build information string.

Returns: C-string containing build information (e.g., compiler, options, date).

◆ librpa_get_major_version()

int librpa_get_major_version ( void )

Get major version number.

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

◆ librpa_get_minor_version()

int librpa_get_minor_version ( void )

Get minor version number.

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

◆ librpa_get_patch_version()

int librpa_get_patch_version ( void )

Get patch version number.

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

◆ librpa_init_global()

void librpa_init_global	(	LibrpaSwitch	switch_redirect_stdout = LIBRPA_SWITCH_OFF,
		const char *	redirect_path = "stdout",
		LibrpaSwitch	switch_process_output = LIBRPA_SWITCH_ON )

Initialize the global LibRPA environment.

Must be called after MPI_Init() and before any other LibRPA functions. Sets up logging, profiling, and parallel communication infrastructure.

Parameters

switch_redirect_stdout	If LIBRPA_SWITCH_ON, redirect stdout to a file. Default is LIBRPA_SWITCH_OFF.
redirect_path	Path for redirected output (default: "stdout"). Only used when switch_redirect_stdout is ON.
switch_process_output	If LIBRPA_SWITCH_ON, enable per-process output files. Default is LIBRPA_SWITCH_ON.

◆ librpa_print_profile()

void librpa_print_profile ( void )

Print profiling information.

Outputs timing and memory usage statistics collected during computation. Only produces meaningful output if profiling was enabled at compile time.

◆ librpa_test()

void librpa_test ( void )

Run internal self-tests.

Performs basic sanity checks on LibRPA functionality. Useful for debugging.