GNU Radio Manual and C++ API Reference  3.7.4
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
volk.tmpl.h File Reference
#include <volk/volk_typedefs.h>
#include <volk/volk_config_fixed.h>
#include <volk/volk_common.h>
#include <volk/volk_complex.h>
#include <volk/volk_malloc.h>
#include <stdlib.h>
#include <stdbool.h>
Include dependency graph for volk.tmpl.h:

Go to the source code of this file.

Classes

struct  volk_func_desc
 

Macros

#define VOLK_OR_PTR(ptr0, ptr1)   (const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))
 

Typedefs

typedef __VOLK_DECL_BEGIN
struct volk_func_desc 
volk_func_desc_t
 

Functions

VOLK_API void volk_list_machines (void)
 Prints a list of machines available. More...
 
VOLK_API const char * volk_get_machine (void)
 Returns the name of the machine this instance will use. More...
 
VOLK_API size_t volk_get_alignment (void)
 Get the machine alignment in bytes. More...
 
VOLK_API bool volk_is_aligned (const void *ptr)
 
VOLK_API $kern pname (kern.name) _a
 A function pointer to the fastest aligned implementation. More...
 
VOLK_API void (kern.name) _manual($kern.arglist_full
 Call into a specific implementation given by name. More...
 
VOLK_API volk_func_desc_t (kern.name) _get_func_desc(void)
 Get description paramaters for this kernel. More...
 

Variables

VOLK_API $kern pname $kern name
 A function pointer to the dispatcher implementation. More...
 
VOLK_API const char * impl_name
 

Macro Definition Documentation

#define VOLK_OR_PTR (   ptr0,
  ptr1 
)    (const void *)(((intptr_t)(ptr0)) | ((intptr_t)(ptr1)))

The VOLK_OR_PTR macro is a convenience macro for checking the alignment of a set of pointers. Example usage: volk_is_aligned(VOLK_OR_PTR((VOLK_OR_PTR(p0, p1), p2)))

Typedef Documentation

Function Documentation

VOLK_API $kern pname ( kern.  name)

A function pointer to the fastest aligned implementation.

A function pointer to the fastest unaligned implementation.

VOLK_API volk_func_desc_t ( kern.  name)

Get description paramaters for this kernel.

VOLK_API size_t volk_get_alignment ( void  )

Get the machine alignment in bytes.

VOLK_API const char* volk_get_machine ( void  )

Returns the name of the machine this instance will use.

VOLK_API bool volk_is_aligned ( const void ptr)

Is the pointer on a machine alignment boundary?

Note: for performance reasons, this function is not usable until another volk API call is made which will perform certain initialization tasks.

Parameters
ptrthe pointer to some memory buffer
Returns
1 for alignment boundary, else 0
VOLK_API void volk_list_machines ( void  )

Prints a list of machines available.

Variable Documentation

VOLK_API const char* impl_name

A function pointer to the dispatcher implementation.