librpa.hpp File Reference

librpa.hpp File Reference#

LibRPA: librpa.hpp File Reference

LibRPA

C++ wrapper API for LibRPA. More...

#include "librpa_enums.h"
#include "librpa_options.h"
#include "librpa_handler.h"
#include <vector>
#include <complex>

Include dependency graph for librpa.hpp:

Classes
class	librpa::Options
	C++ wrapper for runtime options. More...

class	librpa::Handler
	Main handler class for LibRPA computations. More...

Namespaces
namespace	librpa
	Main namespace for LibRPA C++ API.

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

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

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

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

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

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 (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	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.

C++ wrapper API for LibRPA.

This file provides a convenient C++ interface to LibRPA functionality. It wraps the C API with STL containers for easier use.

Usage:

#include "librpa.hpp"

C++ wrapper API for LibRPA.

Note: This header includes librpa_options.h and librpa_handler.h which provide the underlying C types.