peak::ipl::Library Class Reference

Library related functions. More...

#include <peak_ipl/library/peak_ipl_library.hpp>

Public Member Functions
	Library ()=delete
	~Library ()=delete
	Library (const Library &)=delete
	Library (Library &&)=delete
Library &	operator= (const Library &)=delete
Library &	operator= (Library &&)=delete

Static Public Member Functions
static Version_t	Version ()
	Queries the library version.
static size_t	MaxConcurrentThreads ()
	Queries the maximum number of concurrent threads used by the library.
static void	SetMaxConcurrentThreads (size_t concurrentThreads)
	Sets the maximum number of concurrent threads used by the library.
static bool	MultiThreadingEnabled ()
	Get if multithreading is enabled in the library.
static void	SetMultiThreadingEnabled (bool enabled)
	Disables/Enables multithreading in the library.
static bool	SIMDEnabled ()
	Get if SIMD is enabled in the library.
static void	SetSIMDEnabled (bool enabled)
	Disables/Enables SIMD in the library.

Detailed Description

Library related functions.

Constructor & Destructor Documentation

Library() [1/3]

peak::ipl::Library::Library ( )

delete

~Library()

peak::ipl::Library::~Library ( )

delete

Library() [2/3]

peak::ipl::Library::Library ( const Library &  )

delete

Library() [3/3]

peak::ipl::Library::Library ( Library &&  )

delete

Member Function Documentation

MaxConcurrentThreads()

size_t peak::ipl::Library::MaxConcurrentThreads ( )

inlinestatic

Queries the maximum number of concurrent threads used by the library.

Returns

The number of concurrent threads used by the library. Or 0 to let the library decide.

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

MultiThreadingEnabled()

bool peak::ipl::Library::MultiThreadingEnabled ( )

inlinestatic

Get if multithreading is enabled in the library.

Returns

true if multithreading is enabled, false otherwise.

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

operator=() [1/2]

Library & peak::ipl::Library::operator= ( const Library &  )

delete

operator=() [2/2]

Library & peak::ipl::Library::operator= ( Library &&  )

delete

SetMaxConcurrentThreads()

void peak::ipl::Library::SetMaxConcurrentThreads ( size_t  concurrentThreads )

inlinestatic

Sets the maximum number of concurrent threads used by the library.

Set the number of threads to 0, to let the library decide the amount. Select any other number to set the amount manually.

Parameters

[in]

concurrentThreads

The number of concurrent threads used by the library.

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

SetMultiThreadingEnabled()

void peak::ipl::Library::SetMultiThreadingEnabled ( bool  enabled )

inlinestatic

Disables/Enables multithreading in the library.

Parameters

[in]

enabled

set to true to enable multithreading, false to disable it

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

SetSIMDEnabled()

void peak::ipl::Library::SetSIMDEnabled ( bool  enabled )

inlinestatic

Disables/Enables SIMD in the library.

Parameters

[in]

enabled

set to true to use the SIMD optimized functions, false to disable them

Note

This is normally true

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

SIMDEnabled()

bool peak::ipl::Library::SIMDEnabled ( )

inlinestatic

Get if SIMD is enabled in the library.

Returns

True, if SIMD optimized versions are used, otherwise they're not used.

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

Version()

Version_t peak::ipl::Library::Version ( )

inlinestatic

Queries the library version.

Returns

The library version as Version_t

Exceptions

Exception

An internal error has occurred.

Since

1.9.2

---

The documentation for this class was generated from the following file:

• peak_ipl/library/peak_ipl_library.hpp