Generic - Definition. More...

#include "generic.h"
#include <assert.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <math.h>

Include dependency graph for generic.c:

Go to the source code of this file.

Classes
struct	_VlState
struct	_VlThreadState
Typedefs
typedef struct _VlState	VlState
typedef struct _VlThreadState	VlThreadState
Functions
static int	do_nothing_printf (char const *format VL_UNUSED,...)
void *	vl_calloc (size_t n, size_t size)
	Free and clear a memory block.
char *	vl_configuration_to_string_copy ()
	Get VLFeat configuration string.
static void	vl_constructor (void)
vl_bool	vl_cpu_has_avx (void)
	Check for AVX instruction set.
vl_bool	vl_cpu_has_sse2 (void)
	Check for SSE2 instruction set.
vl_bool	vl_cpu_has_sse3 (void)
	Check for SSE3 instruction set.
static void	vl_destructor ()
void	vl_free (void *ptr)
	Free a memory block.
double	vl_get_cpu_time ()
	Get processor time.
int	vl_get_last_error (void)
	Get the code of the last error.
char const *	vl_get_last_error_message (void)
	Get the last error message.
vl_size	vl_get_max_threads (void)
	Get the maximum number of computational threads used by VLFeat.
vl_size	vl_get_num_cpus (void)
	Get the number of CPU cores of the host.
printf_func_t	vl_get_printf_func (void)
	Get the printf function.
VL_EXPORT VlRand *	vl_get_rand (void)
	Get the default random number generator.
vl_bool	vl_get_simd_enabled (void)
	Are SIMD instructons enabled?
VL_INLINE VlState *	vl_get_state ()
vl_size	vl_get_thread_limit (void)
	Get the number of computational threads available to the application.
VL_INLINE VlThreadState *	vl_get_thread_specific_state ()
char const *	vl_get_version_string ()
	Get VLFeat version string.
static void	vl_lock_state (void)
void *	vl_malloc (size_t n)
	Allocate a memory block.
void *	vl_realloc (void *ptr, size_t n)
	Reallocate a memory block.
void	vl_set_alloc_func (void (malloc_func)(size_t), void (realloc_func)(void , size_t), void (calloc_func)(size_t, size_t), void(free_func)(void *))
	Set memory allocation functions.
int	vl_set_last_error (int error, char const *errorMessage,...)
	Set last VLFeat error.
void	vl_set_num_threads (vl_size numThreads VL_UNUSED)
	Set the maximum number of threads used by VLFeat.
void	vl_set_printf_func (printf_func_t printf_func)
	Set the printf function.
void	vl_set_simd_enabled (vl_bool x)
	Toggle usage of SIMD instructions.
static void	vl_thread_specific_state_delete (VlThreadState *self)
static VlThreadState *	vl_thread_specific_state_new (void)
void	vl_tic (void)
	Reset processor time reference The function resets VLFeat TIC/TOC time reference. There is one such reference per thread.
double	vl_toc (void)
	Get elapsed time since tic.
static void	vl_unlock_state (void)
Variables
VlState	_vl_state

Detailed Description

Generic - Definition.

Author:: Andrea Vedaldi

Definition in file generic.c.

Typedef Documentation

typedef struct _VlState VlState

typedef struct _VlThreadState VlThreadState

Function Documentation

static int do_nothing_printf	(	char const *format	VL_UNUSED,
			...
	)		`[static]`

Definition at line 928 of file generic.c.

void* vl_calloc	(	size_t	n,
		size_t	size
	)

Free and clear a memory block.

Parameters:

n	number of items to allocate.
size	size in bytes of an item.

Returns:: pointer to the new block.

This function allocates and clears a memory block. The synopsis is the same as the POSIX calloc function.

Definition at line 1345 of file generic.c.

char* vl_configuration_to_string_copy ( void )

Get VLFeat configuration string.

Returns:: a new configuration string.

The function returns a new string containing a human readable description of the library configuration.

Definition at line 881 of file generic.c.

static void vl_constructor ( void ) [static]

Definition at line 1567 of file generic.c.

vl_bool vl_cpu_has_avx ( void )

Check for AVX instruction set.

Returns:: true if AVX is present.

Definition at line 1092 of file generic.c.

vl_bool vl_cpu_has_sse2 ( void )

Check for SSE2 instruction set.

Returns:: true if SSE2 is present.

Definition at line 1120 of file generic.c.

vl_bool vl_cpu_has_sse3 ( void )

Check for SSE3 instruction set.

Returns:: true if SSE3 is present.

Definition at line 1106 of file generic.c.

static void vl_destructor ( ) [static]

Definition at line 1641 of file generic.c.

void vl_free ( void * ptr )

Free a memory block.

Parameters:

ptr	pointer to the memory block.

This function frees a memory block allocated by vl_malloc, vl_calloc, or vl_realloc. The synopsis is the same as the POSIX malloc function.

Definition at line 1359 of file generic.c.

double vl_get_cpu_time ( void )

Get processor time.

Returns:: processor time in seconds.

See also:: vl_tic, vl_toc

Definition at line 1394 of file generic.c.

int vl_get_last_error ( void )

Get the code of the last error.

Returns:: error code.

See also:: vl_get_last_error_message.

Definition at line 1265 of file generic.c.

char const* vl_get_last_error_message ( void )

Get the last error message.

Returns:: pointer to the error message.

See also:: vl_get_last_error.

Definition at line 1275 of file generic.c.

vl_size vl_get_max_threads ( void )

Get the maximum number of computational threads used by VLFeat.

Returns:: number of threads.

This function returns the maximum number of thread used by VLFeat. VLFeat will try to use this number of computational threads and never exceed it.

This is similar to the OpenMP function omp_get_max_threads(); however, it reads a parameter private to VLFeat which is independent of the value used by the OpenMP library.

If VLFeat was compiled without OpenMP support, this function returns 1.

See also:: vl_set_num_threads(), Parallel computations

Definition at line 1175 of file generic.c.

vl_size vl_get_num_cpus ( void )

Get the number of CPU cores of the host.

Returns:: number of CPU cores.

Definition at line 1055 of file generic.c.

printf_func_t vl_get_printf_func ( void )

Get the printf function.

Returns:: printf_func pointer to the printf implementation.

See also:: vl_set_printf_func.

Definition at line 1383 of file generic.c.

VL_EXPORT VlRand* vl_get_rand ( void )

Get the default random number generator.

Returns:: random number generator.

The function returns a pointer to the default random number generator. There is one such generator per thread.

Definition at line 1461 of file generic.c.

vl_bool vl_get_simd_enabled ( void )

Are SIMD instructons enabled?

Returns:: true if SIMD instructions are enabled.

Definition at line 1082 of file generic.c.

VL_INLINE VlState * vl_get_state ( void )

Definition at line 1005 of file generic.c.

vl_size vl_get_thread_limit ( void )

Get the number of computational threads available to the application.

Returns:: number of threads.

This function wraps the OpenMP function omp_get_thread_limit(). If VLFeat was compiled without OpenMP support, this function returns 1. If VLFeat was compiled with OpenMP prior to version 3.0 (2008/05), it returns 0.

See also:: Parallel computations

Definition at line 1143 of file generic.c.

VL_INLINE VlThreadState * vl_get_thread_specific_state ( void )

Definition at line 1017 of file generic.c.

char const* vl_get_version_string ( void )

Get VLFeat version string.

Returns:: the library version string.

Definition at line 868 of file generic.c.

static void vl_lock_state ( void ) [static]

Definition at line 946 of file generic.c.

void* vl_malloc ( size_t n )

Allocate a memory block.

Parameters:

n	size in bytes of the new block.

Returns:: pointer to the allocated block.

This function allocates a memory block of the specified size. The synopsis is the same as the POSIX malloc function.

Definition at line 1313 of file generic.c.

void* vl_realloc	(	void *	ptr,
		size_t	n
	)

Reallocate a memory block.

Parameters:

ptr	pointer to a memory block previously allocated.
n	size in bytes of the new block.

Returns:: pointer to the new block.

This function reallocates a memory block to change its size. The synopsis is the same as the POSIX realloc function.

Definition at line 1330 of file generic.c.

void vl_set_alloc_func	(	void ()(size_t)	malloc_func,
		void ()(void *, size_t)	realloc_func,
		void ()(size_t, size_t)	calloc_func,
		void()(void )	free_func
	)

Set memory allocation functions.

Parameters:

malloc_func	pointer to `malloc`.
realloc_func	pointer to `realloc`.
calloc_func	pointer to `calloc`.
free_func	pointer to `free`.

Definition at line 1289 of file generic.c.

int vl_set_last_error	(	int	error,
		char const *	errorMessage,
			...
	)

Set last VLFeat error.

Parameters:

error	error code.
errorMessage	error message format string.
...	format string arguments.

Returns:: error code.

The function sets the code and optionally the error message of the last encountered error. errorMessage is the message format. It uses the printf convention and is followed by the format arguments. The maximum length of the error message is given by VL_ERR_MSG_LEN (longer messages are truncated).

Passing NULL as errorMessage sets the error message to the empty string.

Definition at line 1238 of file generic.c.

void vl_set_num_threads ( vl_size numThreads VL_UNUSED )

Set the maximum number of threads used by VLFeat.

Parameters:

numThreads number of threads to use.

This function sets the maximum number of computational threads that will be used by VLFeat. VLFeat may in practice use fewer threads (for example because numThreads is larger than the number of computational cores in the host, or because the number of threads exceeds the limit available to the application).

If numThreads is set to 0, then VLFeat sets the number of threads to the OpenMP current maximum, obtained by calling omp_get_max_threads().

This function is similar to omp_set_num_threads() but changes a parameter internal to VLFeat rather than affecting OpenMP global state.

If VLFeat was compiled without, this function does nothing.

See also:: vl_get_max_threads(), Parallel computations

Definition at line 1217 of file generic.c.

void vl_set_printf_func ( printf_func_t printf_func )

Set the printf function.

Parameters:

printf_func pointer to a printf implementation. Set print_func to NULL to disable printf.

Definition at line 1372 of file generic.c.

vl_set_simd_enabled ( vl_bool x )

Toggle usage of SIMD instructions.

Parameters:

x	`true` if SIMD instructions are used.

Notice that SIMD instructions are used only if the CPU model supports them. Note also that data alignment may restrict the use of such instructions.

See also:: vl_cpu_has_sse2(), vl_cpu_has_sse3(), etc.

Definition at line 1072 of file generic.c.

static void vl_thread_specific_state_delete ( VlThreadState * self ) [static]

Definition at line 1500 of file generic.c.

static VlThreadState * vl_thread_specific_state_new ( void ) [static]

Definition at line 1475 of file generic.c.

void vl_tic ( void )

Reset processor time reference The function resets VLFeat TIC/TOC time reference. There is one such reference per thread.

See also:: vl_get_cpu_time, vl_toc.

Definition at line 1413 of file generic.c.

double vl_toc ( void )

Get elapsed time since tic.

Returns:: elapsed time in seconds.

The function returns the processor time elapsed since vl_tic was called last.

Remarks:: In multi-threaded applications, there is an independent timer for each execution thread.; On UNIX, this function uses the clock() system call. On Windows, it uses the QueryPerformanceCounter() system call, which is more accurate than clock() on this platform.

Definition at line 1438 of file generic.c.

static void vl_unlock_state ( void ) [static]

Definition at line 979 of file generic.c.

Variable Documentation

VlState _vl_state

Definition at line 853 of file generic.c.

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

Function Documentation

Variable Documentation