OpenMS
OpenMSBuildInfo Struct Reference

Struct with some static methods to get informations on the build configuration. More...

#include <OpenMS/SYSTEM/BuildInfo.h>

Static Public Member Functions

static bool isOpenMPEnabled ()
 Checks if OpenMP was enabled during build, based on the _OPENMP macro. More...
 
static String getBuildType ()
 Get the build type used during building the OpenMS library. More...
 
static Size getOpenMPMaxNumThreads ()
 Get the maximum number of threads that OpenMP will use (including hyperthreads) Note: This could also be limited by the OMP_NUM_THREADS environment variable Returns 1 if OpenMP was disabled. More...
 
static void setOpenMPNumThreads (Int num_threads)
 Set the number of threads that OpenMP will use (including hyperthreads) Note: Can be initialized by the OMP_NUM_THREADS environment variable. This function can overwrite this at runtime. More...
 

Detailed Description

Struct with some static methods to get informations on the build configuration.

Member Function Documentation

◆ getBuildType()

static String getBuildType ( )
inlinestatic

Get the build type used during building the OpenMS library.

◆ getOpenMPMaxNumThreads()

static Size getOpenMPMaxNumThreads ( )
inlinestatic

Get the maximum number of threads that OpenMP will use (including hyperthreads) Note: This could also be limited by the OMP_NUM_THREADS environment variable Returns 1 if OpenMP was disabled.

◆ isOpenMPEnabled()

static bool isOpenMPEnabled ( )
inlinestatic

Checks if OpenMP was enabled during build, based on the _OPENMP macro.

◆ setOpenMPNumThreads()

static void setOpenMPNumThreads ( Int  num_threads)
inlinestatic

Set the number of threads that OpenMP will use (including hyperthreads) Note: Can be initialized by the OMP_NUM_THREADS environment variable. This function can overwrite this at runtime.