FFTLIB_bufParams.h File Reference

Introduction

File to hold buffer parameter related info for FFTLIB.

Version

0.1 - Jan 2018 : Initial Version with as a template [PKS]

Definition in file FFTLIB_bufParams.h.

Go to the source code of this file.

Data Structures
struct	FFTLIB_bufParams1D_t
	A structure for a 1 dimensional buffer descriptor. More...
struct	FFTLIB_bufParams2D_t
	A structure for a 2 dimensional buffer descriptor. More...
struct	FFTLIB_bufParams3D_t
	A structure for a 3 dimensional buffer descriptor. More...
struct	FFTLIB_bufParamsND_t
	A structure for a N dimensional buffer descriptor. More...

Macros
#define	FFTLIB_ISSIGNED(type)   ((type) < FFTLIB_UINT8 || (type) > FFTLIB_UINT128)
#define	FFTLIB_SIGNEDNESS(type)   (FFTLIB_ISSIGNED((type)) ? "signed" : "unsigned")

Enumerations
enum	FFTLIB_data_type_e {   FFTLIB_INT8 = 0 , FFTLIB_INT16 = 1 , FFTLIB_INT32 = 2 , FFTLIB_INT64 = 3 ,   FFTLIB_INT128 = 4 , FFTLIB_UINT8 = 5 , FFTLIB_UINT16 = 6 , FFTLIB_UINT24 = 7 ,   FFTLIB_UINT32 = 8 , FFTLIB_UINT64 = 9 , FFTLIB_UINT128 = 10 , FFTLIB_FLOAT16 = 11 ,   FFTLIB_FLOAT32 = 12 , FFTLIB_FLOAT64 = 13 }
	The enumeration of all data types. More...
enum	FFTLIB_dimension_e {   FFTLIB_2D = 0 , FFTLIB_3D = 1 , FFTLIB_4D = 2 , FFTLIB_5D = 3 ,   FFTLIB_6D = 4 }
	The enumeration of multidimensional buffer types. More...

Functions
static int32_t	FFTLIB_sizeof (uint32_t type)
	Inline function returns number of bytes per element given a type of _FFTLIB_data_type_e. More...

Macro Definition Documentation

FFTLIB_ISSIGNED

#define FFTLIB_ISSIGNED

(

type

)

((type) < FFTLIB_UINT8 || (type) > FFTLIB_UINT128)

Definition at line 69 of file FFTLIB_bufParams.h.

FFTLIB_SIGNEDNESS

#define FFTLIB_SIGNEDNESS

(

type

)

(FFTLIB_ISSIGNED((type)) ? "signed" : "unsigned")

Definition at line 70 of file FFTLIB_bufParams.h.

Enumeration Type Documentation

FFTLIB_data_type_e

enum FFTLIB_data_type_e

The enumeration of all data types.

Enumerator
FFTLIB_INT8	Signed 8-bit integer
FFTLIB_INT16	Signed 16-bit integer
FFTLIB_INT32	Signed 32-bit integer
FFTLIB_INT64	Signed 64-bit integer
FFTLIB_INT128	Signed 128-bit integer
FFTLIB_UINT8	Unsigned 8-bit integer
FFTLIB_UINT16	Unsigned 16-bit integer
FFTLIB_UINT24	Unsigned 24-bit integer
FFTLIB_UINT32	Unsigned 32-bit integer
FFTLIB_UINT64	Unsigned 64-bit integer
FFTLIB_UINT128	Unsigned 128-bit integer
FFTLIB_FLOAT16	16-bit floating point number
FFTLIB_FLOAT32	32-bit floating point number
FFTLIB_FLOAT64	64-bit floating point number

Definition at line 40 of file FFTLIB_bufParams.h.

FFTLIB_dimension_e

enum FFTLIB_dimension_e

The enumeration of multidimensional buffer types.

Enumerator
FFTLIB_2D	Two dimensional buffer
FFTLIB_3D	Three dimensional buffer
FFTLIB_4D	Four dimensional buffer
FFTLIB_5D	Five dimensional buffer
FFTLIB_6D	Six dimensional buffer

Definition at line 73 of file FFTLIB_bufParams.h.

Function Documentation

FFTLIB_sizeof()

static int32_t FFTLIB_sizeof ( uint32_t  type )

inlinestatic

Inline function returns number of bytes per element given a type of _FFTLIB_data_type_e.

Definition at line 145 of file FFTLIB_bufParams.h.