Generic (General support functionalities) More...
#include "host.h"#include "random.h"#include <stdlib.h>#include <stddef.h>#include <time.h>#include <assert.h>
Go to the source code of this file.
Defines | |
| #define | VL_ERR_MSG_LEN 1024 |
| Maximum length (in characters) of an error message. | |
| #define | VL_VERSION_STRING "0.9.20" |
| Library version string. | |
Common operations | |
------------------------------------------------------------------ | |
| #define | VL_MIN(x, y) (((x)<(y))?(x):(y)) |
| Compute the minimum between two values. | |
| #define | VL_MAX(x, y) (((x)>(y))?(x):(y)) |
| Compute the maximum between two values. | |
| #define | VL_SHIFT_LEFT(x, n) (((n)>=0)?((x)<<(n)):((x)>>-(n))) |
| Signed left shift operation. | |
Functions | |
| VL_EXPORT char * | vl_configuration_to_string_copy (void) |
| Get VLFeat configuration string. | |
| VL_EXPORT vl_bool | vl_cpu_has_avx (void) |
| Check for AVX instruction set. | |
| VL_EXPORT vl_bool | vl_cpu_has_sse2 (void) |
| Check for SSE2 instruction set. | |
| VL_EXPORT vl_bool | vl_cpu_has_sse3 (void) |
| Check for SSE3 instruction set. | |
| VL_EXPORT vl_size | vl_get_num_cpus (void) |
| Get the number of CPU cores of the host. | |
| VL_EXPORT VlRand * | vl_get_rand (void) |
| Get the default random number generator. | |
| VL_EXPORT vl_bool | vl_get_simd_enabled (void) |
| Are SIMD instructons enabled? | |
| VL_EXPORT char const * | vl_get_version_string (void) |
| Get VLFeat version string. | |
| VL_EXPORT void | vl_set_simd_enabled (vl_bool x) |
| Toggle usage of SIMD instructions. | |
Multi-thread computations | |
| VL_EXPORT vl_size | vl_get_max_threads (void) |
| Get the maximum number of computational threads used by VLFeat. | |
| VL_EXPORT void | vl_set_num_threads (vl_size n) |
| VL_EXPORT vl_size | vl_get_thread_limit (void) |
| Get the number of computational threads available to the application. | |
Memory allocation | |
------------------------------------------------------------------ | |
| VL_EXPORT 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. | |
| VL_EXPORT void * | vl_malloc (size_t n) |
| Allocate a memory block. | |
| VL_EXPORT void * | vl_realloc (void *ptr, size_t n) |
| Reallocate a memory block. | |
| VL_EXPORT void * | vl_calloc (size_t n, size_t size) |
| Free and clear a memory block. | |
| VL_EXPORT void * | vl_memalign (size_t n, size_t size) |
| VL_EXPORT void | vl_free (void *ptr) |
| Free a memory block. | |
Measuring time | |
------------------------------------------------------------------ | |
| VL_EXPORT void | vl_tic (void) |
| Reset processor time reference The function resets VLFeat TIC/TOC time reference. There is one such reference per thread. | |
| VL_EXPORT double | vl_toc (void) |
| Get elapsed time since tic. | |
| VL_EXPORT double | vl_get_cpu_time (void) |
| Get processor time. | |
Type identifiers for atomic data types | |
| #define | VL_TYPE_FLOAT 1 |
| #define | VL_TYPE_DOUBLE 2 |
| #define | VL_TYPE_INT8 3 |
| #define | VL_TYPE_UINT8 4 |
| #define | VL_TYPE_INT16 5 |
| #define | VL_TYPE_UINT16 6 |
| #define | VL_TYPE_INT32 7 |
| #define | VL_TYPE_UINT32 8 |
| #define | VL_TYPE_INT64 9 |
| #define | VL_TYPE_UINT64 10 |
| typedef vl_uint32 | vl_type |
| VL_INLINE char const * | vl_get_type_name (vl_type type) |
| Get the name of a data type. | |
| VL_INLINE vl_size | vl_get_type_size (vl_type type) |
| Get data type size. | |
Error handling | |
------------------------------------------------------------------ | |
| #define | VL_ERR_OK 0 |
| #define | VL_ERR_OVERFLOW 1 |
| #define | VL_ERR_ALLOC 2 |
| #define | VL_ERR_BAD_ARG 3 |
| #define | VL_ERR_IO 4 |
| #define | VL_ERR_EOF 5 |
| #define | VL_ERR_NO_MORE 5 |
| VL_EXPORT int | vl_get_last_error (void) |
| Get the code of the last error. | |
| VL_EXPORT char const * | vl_get_last_error_message (void) |
| Get the last error message. | |
| VL_EXPORT int | vl_set_last_error (int error, char const *errorMessage,...) |
| Set last VLFeat error. | |
Logging | |
------------------------------------------------------------------ | |
| #define | VL_PRINTF (*vl_get_printf_func()) |
Call user-customizable printf function. | |
| #define | VL_PRINT (*vl_get_printf_func()) |
| Same as VL_PRINTF (legacy code) | |
| typedef int(* | printf_func_t )(char const *format,...) |
| Customizable printf function pointer type. | |
| VL_EXPORT void | vl_set_printf_func (printf_func_t printf_func) |
| Set the printf function. | |
| VL_EXPORT printf_func_t | vl_get_printf_func (void) |
| Get the printf function. | |
Detailed Description
Generic (General support functionalities)
Definition in file generic.h.
Define Documentation
| #define VL_ERR_ALLOC 2 |
| #define VL_ERR_BAD_ARG 3 |
| #define VL_ERR_EOF 5 |
| #define VL_ERR_MSG_LEN 1024 |
| #define VL_ERR_NO_MORE 5 |
| #define VL_ERR_OVERFLOW 1 |
| #define VL_MAX | ( | x, | |
| y | |||
| ) | (((x)>(y))?(x):(y)) |
| #define VL_MIN | ( | x, | |
| y | |||
| ) | (((x)<(y))?(x):(y)) |
| #define VL_PRINT (*vl_get_printf_func()) |
| #define VL_PRINTF (*vl_get_printf_func()) |
| #define VL_SHIFT_LEFT | ( | x, | |
| n | |||
| ) | (((n)>=0)?((x)<<(n)):((x)>>-(n))) |
| #define VL_TYPE_DOUBLE 2 |
| #define VL_TYPE_FLOAT 1 |
| #define VL_TYPE_INT16 5 |
| #define VL_TYPE_INT32 7 |
| #define VL_TYPE_INT64 9 |
| #define VL_TYPE_INT8 3 |
| #define VL_TYPE_UINT16 6 |
| #define VL_TYPE_UINT32 8 |
| #define VL_TYPE_UINT64 10 |
| #define VL_TYPE_UINT8 4 |
| #define VL_VERSION_STRING "0.9.20" |
Typedef Documentation
| typedef int(* printf_func_t)(char const *format,...) |
Function Documentation
| VL_EXPORT char* vl_configuration_to_string_copy | ( | void | ) |
| VL_EXPORT vl_bool vl_cpu_has_avx | ( | void | ) |
| VL_EXPORT vl_bool vl_cpu_has_sse2 | ( | void | ) |
| VL_EXPORT vl_bool vl_cpu_has_sse3 | ( | void | ) |
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.
| VL_EXPORT double vl_get_cpu_time | ( | void | ) |
| VL_EXPORT int vl_get_last_error | ( | void | ) |
| VL_EXPORT char const* vl_get_last_error_message | ( | void | ) |
| VL_EXPORT 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
| VL_EXPORT vl_size vl_get_num_cpus | ( | void | ) |
| VL_EXPORT printf_func_t vl_get_printf_func | ( | void | ) |
Get the printf function.
- Returns:
- printf_func pointer to the
printfimplementation.
- See also:
- vl_set_printf_func.
| VL_EXPORT VlRand* vl_get_rand | ( | void | ) |
| VL_EXPORT vl_bool vl_get_simd_enabled | ( | void | ) |
| VL_EXPORT 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
| VL_INLINE char const* vl_get_type_name | ( | vl_type | type | ) |
Get the name of a data type.
- Parameters:
-
type data type.
- Returns:
- data name of the data type.
type is one of VL_TYPE_FLOAT, VL_TYPE_DOUBLE, VL_TYPE_INT8, VL_TYPE_INT16, VL_TYPE_INT32, VL_TYPE_INT64, VL_TYPE_UINT8, VL_TYPE_UINT16, VL_TYPE_UINT32, VL_TYPE_UINT64.
| VL_INLINE vl_size vl_get_type_size | ( | vl_type | type | ) |
Get data type size.
- Parameters:
-
type data type.
- Returns:
- size (in byte)
type is one of VL_TYPE_FLOAT, VL_TYPE_DOUBLE, VL_TYPE_INT8, VL_TYPE_INT16, VL_TYPE_INT32, VL_TYPE_INT64, VL_TYPE_UINT8, VL_TYPE_UINT16, VL_TYPE_UINT32, VL_TYPE_UINT64.
| VL_EXPORT char const* vl_get_version_string | ( | void | ) |
| VL_EXPORT void* vl_memalign | ( | size_t | n, |
| size_t | size | ||
| ) |
| VL_EXPORT 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.
| VL_EXPORT 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.
| VL_EXPORT void vl_set_num_threads | ( | vl_size | n | ) |
| VL_EXPORT void vl_set_printf_func | ( | printf_func_t | printf_func | ) |
| VL_EXPORT void vl_set_simd_enabled | ( | vl_bool | x | ) |
Toggle usage of SIMD instructions.
- Parameters:
-
x trueif 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.
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.
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 theQueryPerformanceCounter()system call, which is more accurate thanclock()on this platform.