EMAN2
Macros | Enumerations | Functions
cuda_defs.h File Reference

Go to the source code of this file.

Macros

#define DLL_MAPPING
 
#define CUTIL_API
 
#define CUT_BANK_CHECKER(array, index)   array[index]
 Macros. More...
 
#define CUT_CHECK_ERROR(errorMessage)
 
#define CUT_CHECK_ERROR_GL()
 
#define CUT_CONDITION(val)
 
#define CU_SAFE_CALL_NO_SYNC(call)   call
 
#define CU_SAFE_CALL(call)   call
 
#define CUDA_SAFE_CALL_NO_SYNC(call)   call
 
#define CUDA_SAFE_CALL(call)   call
 
#define CUT_SAFE_CALL(call)   call
 
#define CUFFT_SAFE_CALL(call)   call
 
#define CUT_SAFE_MALLOC(mallocCall)   mallocCall
 
#define CUT_DEVICE_INIT(ARGC, ARGV)
 
#define CUT_DEVICE_INIT_DRV(cuDevice, ARGC, ARGV)
 
#define CUT_EXIT(argc, argv)
 

Enumerations

enum  CUTBoolean { CUTFalse = 0 , CUTTrue = 1 }
 CUT bool type. More...
 

Functions

DLL_MAPPING void CUTIL_API cutFree (void *ptr)
 Deallocate memory allocated within Cutil. More...
 
DLL_MAPPING void CUTIL_API cutCheckBankAccess (unsigned int tidx, unsigned int tidy, unsigned int tidz, unsigned int bdimx, unsigned int bdimy, unsigned int bdimz, const char *file, const int line, const char *aname, const int index)
 Helper for bank conflict checking (should only be used with the CUT_BANK_CHECKER macro) More...
 
DLL_MAPPING char *CUTIL_API cutFindFilePath (const char *filename, const char *executablePath)
 Find the path for a filename. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutReadFilef (const char *filename, float **data, unsigned int *len, bool verbose=false)
 Read file \filename containing single precision floating point data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutReadFiled (const char *filename, double **data, unsigned int *len, bool verbose=false)
 Read file \filename containing double precision floating point data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutReadFilei (const char *filename, int **data, unsigned int *len, bool verbose=false)
 Read file \filename containing integer data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutReadFileui (const char *filename, unsigned int **data, unsigned int *len, bool verbose=false)
 Read file \filename containing unsigned integer data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutReadFileb (const char *filename, char **data, unsigned int *len, bool verbose=false)
 Read file \filename containing char / byte data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutReadFileub (const char *filename, unsigned char **data, unsigned int *len, bool verbose=false)
 Read file \filename containing unsigned char / byte data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutWriteFilef (const char *filename, const float *data, unsigned int len, const float epsilon, bool verbose=false)
 Write a data file \filename containing single precision floating point data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutWriteFiled (const char *filename, const float *data, unsigned int len, const double epsilon, bool verbose=false)
 Write a data file \filename containing double precision floating point data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutWriteFilei (const char *filename, const int *data, unsigned int len, bool verbose=false)
 Write a data file \filename containing integer data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutWriteFileui (const char *filename, const unsigned int *data, unsigned int len, bool verbose=false)
 Write a data file \filename containing unsigned integer data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutWriteFileb (const char *filename, const char *data, unsigned int len, bool verbose=false)
 Write a data file \filename containing char / byte data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutWriteFileub (const char *filename, const unsigned char *data, unsigned int len, bool verbose=false)
 Write a data file \filename containing unsigned char / byte data. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMub (const char *file, unsigned char **data, unsigned int *w, unsigned int *h)
 Load PGM image file (with unsigned char as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutLoadPPMub (const char *file, unsigned char **data, unsigned int *w, unsigned int *h)
 Load PPM image file (with unsigned char as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutLoadPPM4ub (const char *file, unsigned char **data, unsigned int *w, unsigned int *h)
 Load PPM image file (with unsigned char as data element type), padding 4th component. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMi (const char *file, unsigned int **data, unsigned int *w, unsigned int *h)
 Load PGM image file (with unsigned int as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMs (const char *file, unsigned short **data, unsigned int *w, unsigned int *h)
 Load PGM image file (with unsigned short as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMf (const char *file, float **data, unsigned int *w, unsigned int *h)
 Load PGM image file (with float as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMub (const char *file, unsigned char *data, unsigned int w, unsigned int h)
 Save PGM image file (with unsigned char as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutSavePPMub (const char *file, unsigned char *data, unsigned int w, unsigned int h)
 Save PPM image file (with unsigned char as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutSavePPM4ub (const char *file, unsigned char *data, unsigned int w, unsigned int h)
 Save PPM image file (with unsigned char as data element type, padded to 4 bytes) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMi (const char *file, unsigned int *data, unsigned int w, unsigned int h)
 Save PGM image file (with unsigned int as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMs (const char *file, unsigned short *data, unsigned int w, unsigned int h)
 Save PGM image file (with unsigned short as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMf (const char *file, float *data, unsigned int w, unsigned int h)
 Save PGM image file (with float as data element type) More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutCheckCmdLineFlag (const int argc, const char **argv, const char *flag_name)
 Check if command line argument flag-name is given. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumenti (const int argc, const char **argv, const char *arg_name, int *val)
 Get the value of a command line argument of type int. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumentf (const int argc, const char **argv, const char *arg_name, float *val)
 Get the value of a command line argument of type float. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumentstr (const int argc, const char **argv, const char *arg_name, char **val)
 Get the value of a command line argument of type string. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumentListstr (const int argc, const char **argv, const char *arg_name, char **val, unsigned int *len)
 Get the value of a command line argument list those element are strings. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutCheckCondition (int val, const char *file, const int line)
 Extended assert. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutComparef (const float *reference, const float *data, const unsigned int len)
 Compare two float arrays. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutComparei (const int *reference, const int *data, const unsigned int len)
 Compare two integer arrays. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutCompareub (const unsigned char *reference, const unsigned char *data, const unsigned int len)
 Compare two unsigned char arrays. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutCompareube (const unsigned char *reference, const unsigned char *data, const unsigned int len, const int epsilon)
 Compare two integer arrays witha n epsilon tolerance for equality. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutComparefe (const float *reference, const float *data, const unsigned int len, const float epsilon)
 Compare two float arrays with an epsilon tolerance for equality. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutCompareL2fe (const float *reference, const float *data, const unsigned int len, const float epsilon)
 Compare two float arrays using L2-norm with an epsilon tolerance for equality. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutCreateTimer (unsigned int *name)
 Timer functionality. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutDeleteTimer (unsigned int name)
 Delete a timer. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutStartTimer (const unsigned int name)
 Start the time with name name. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutStopTimer (const unsigned int name)
 Stop the time with name name. More...
 
DLL_MAPPING CUTBoolean CUTIL_API cutResetTimer (const unsigned int name)
 Resets the timer's counter. More...
 
DLL_MAPPING float CUTIL_API cutGetTimerValue (const unsigned int name)
 Returns total execution time in milliseconds for the timer over all runs since the last reset or timer creation. More...
 
DLL_MAPPING float CUTIL_API cutGetAverageTimerValue (const unsigned int name)
 Return the average time in milliseconds for timer execution as the total time for the timer dividied by the number of completed (stopped) runs the timer has made. More...
 

Macro Definition Documentation

◆ CU_SAFE_CALL

#define CU_SAFE_CALL (   call)    call

Definition at line 785 of file cuda_defs.h.

◆ CU_SAFE_CALL_NO_SYNC

#define CU_SAFE_CALL_NO_SYNC (   call)    call

Definition at line 784 of file cuda_defs.h.

◆ CUDA_SAFE_CALL

#define CUDA_SAFE_CALL (   call)    call

Definition at line 787 of file cuda_defs.h.

◆ CUDA_SAFE_CALL_NO_SYNC

#define CUDA_SAFE_CALL_NO_SYNC (   call)    call

Definition at line 786 of file cuda_defs.h.

◆ CUFFT_SAFE_CALL

#define CUFFT_SAFE_CALL (   call)    call

Definition at line 789 of file cuda_defs.h.

◆ CUT_BANK_CHECKER

#define CUT_BANK_CHECKER (   array,
  index 
)    array[index]

Macros.

Definition at line 778 of file cuda_defs.h.

◆ CUT_CHECK_ERROR

#define CUT_CHECK_ERROR (   errorMessage)

Definition at line 781 of file cuda_defs.h.

◆ CUT_CHECK_ERROR_GL

#define CUT_CHECK_ERROR_GL ( )

Definition at line 782 of file cuda_defs.h.

◆ CUT_CONDITION

#define CUT_CONDITION (   val)

Definition at line 783 of file cuda_defs.h.

◆ CUT_DEVICE_INIT

#define CUT_DEVICE_INIT (   ARGC,
  ARGV 
)
Value:
{ \
int deviceCount; \
CUDA_SAFE_CALL_NO_SYNC(cudaGetDeviceCount(&deviceCount)); \
if (deviceCount == 0) { \
fprintf(stderr, "cutil error: no devices supporting CUDA.\n"); \
exit(EXIT_FAILURE); \
} \
int dev = 0; \
cutGetCmdLineArgumenti(ARGC, (const char **) ARGV, "device", &dev); \
if (dev > deviceCount-1) dev = deviceCount - 1; \
cudaDeviceProp deviceProp; \
CUDA_SAFE_CALL_NO_SYNC(cudaGetDeviceProperties(&deviceProp, dev)); \
if (deviceProp.major < 1) { \
fprintf(stderr, "cutil error: device does not support CUDA.\n"); \
exit(EXIT_FAILURE); \
} \
if (cutCheckCmdLineFlag(ARGC, (const char **) ARGV, "quiet") == CUTFalse) \
fprintf(stderr, "Using device %d: %s\n", dev, deviceProp.name); \
CUDA_SAFE_CALL(cudaSetDevice(dev)); \
}
#define CUDA_SAFE_CALL_NO_SYNC(call)
Definition: cuda_defs.h:786
DLL_MAPPING CUTBoolean CUTIL_API cutCheckCmdLineFlag(const int argc, const char **argv, const char *flag_name)
Check if command line argument flag-name is given.
@ CUTFalse
Definition: cuda_defs.h:67

Definition at line 800 of file cuda_defs.h.

◆ CUT_DEVICE_INIT_DRV

#define CUT_DEVICE_INIT_DRV (   cuDevice,
  ARGC,
  ARGV 
)
Value:
{ \
cuDevice = 0; \
int deviceCount = 0; \
CUresult err = cuInit(0); \
if (CUDA_SUCCESS == err) \
CU_SAFE_CALL_NO_SYNC(cuDeviceGetCount(&deviceCount)); \
if (deviceCount == 0) { \
fprintf(stderr, "cutil error: no devices supporting CUDA\n"); \
exit(EXIT_FAILURE); \
} \
int dev = 0; \
cutGetCmdLineArgumenti(ARGC, (const char **) ARGV, "device", &dev); \
if (dev > deviceCount-1) dev = deviceCount - 1; \
CU_SAFE_CALL_NO_SYNC(cuDeviceGet(&cuDevice, dev)); \
char name[100]; \
cuDeviceGetName(name, 100, cuDevice); \
if (cutCheckCmdLineFlag(ARGC, (const char **) ARGV, "quiet") == CUTFalse) \
fprintf(stderr, "Using device %d: %s\n", dev, name); \
}
#define CU_SAFE_CALL_NO_SYNC(call)
Definition: cuda_defs.h:784

Definition at line 823 of file cuda_defs.h.

◆ CUT_EXIT

#define CUT_EXIT (   argc,
  argv 
)
Value:
if (!cutCheckCmdLineFlag(argc, (const char**)argv, "noprompt")) { \
printf("\nPress ENTER to exit...\n"); \
fflush( stdout); \
fflush( stderr); \
getchar(); \
} \
exit(EXIT_SUCCESS);

Definition at line 843 of file cuda_defs.h.

◆ CUT_SAFE_CALL

#define CUT_SAFE_CALL (   call)    call

Definition at line 788 of file cuda_defs.h.

◆ CUT_SAFE_MALLOC

#define CUT_SAFE_MALLOC (   mallocCall)    mallocCall

Definition at line 790 of file cuda_defs.h.

◆ CUTIL_API

#define CUTIL_API

Definition at line 58 of file cuda_defs.h.

◆ DLL_MAPPING

#define DLL_MAPPING

Definition at line 52 of file cuda_defs.h.

Enumeration Type Documentation

◆ CUTBoolean

enum CUTBoolean

CUT bool type.

Enumerator
CUTFalse 
CUTTrue 

Definition at line 65 of file cuda_defs.h.

66 {
67 CUTFalse = 0,
68 CUTTrue = 1
69 };
@ CUTTrue
Definition: cuda_defs.h:68

Function Documentation

◆ cutCheckBankAccess()

DLL_MAPPING void CUTIL_API cutCheckBankAccess ( unsigned int  tidx,
unsigned int  tidy,
unsigned int  tidz,
unsigned int  bdimx,
unsigned int  bdimy,
unsigned int  bdimz,
const char *  file,
const int  line,
const char *  aname,
const int  index 
)

Helper for bank conflict checking (should only be used with the CUT_BANK_CHECKER macro)

Parameters
tidxthread id in x dimension of block
tidythread id in y dimension of block
tidzthread id in z dimension of block
bdimxblock size in x dimension
bdimyblock size in y dimension
bdimzblock size in z dimension
filename of the source file where the access takes place
lineline in the source file where the access takes place
anamename of the array which is accessed
indexindex into the array

◆ cutCheckCmdLineFlag()

DLL_MAPPING CUTBoolean CUTIL_API cutCheckCmdLineFlag ( const int  argc,
const char **  argv,
const char *  flag_name 
)

Check if command line argument flag-name is given.

Returns
CUTTrue if command line argument flag_name has been given, otherwise 0
Parameters
argcargc as passed to main()
argvargv as passed to main()
flag_namename of command line flag

◆ cutCheckCondition()

DLL_MAPPING CUTBoolean CUTIL_API cutCheckCondition ( int  val,
const char *  file,
const int  line 
)

Extended assert.

Returns
CUTTrue if the condition val holds, otherwise CUTFalse
Parameters
valcondition to test
fileFILE macro
lineLINE macro
Note
This function should be used via the CONDITION(val) macro

◆ cutComparef()

DLL_MAPPING CUTBoolean CUTIL_API cutComparef ( const float *  reference,
const float *  data,
const unsigned int  len 
)

Compare two float arrays.

Returns
CUTTrue if reference and data are identical, otherwise CUTFalse
Parameters
referencehandle to the reference data / gold image
datahandle to the computed data
lennumber of elements in reference and data

◆ cutComparefe()

DLL_MAPPING CUTBoolean CUTIL_API cutComparefe ( const float *  reference,
const float *  data,
const unsigned int  len,
const float  epsilon 
)

Compare two float arrays with an epsilon tolerance for equality.

Returns
CUTTrue if reference and data are identical, otherwise CUTFalse
Parameters
referencehandle to the reference data / gold image
datahandle to the computed data
lennumber of elements in reference and data
epsilonepsilon to use for the comparison

◆ cutComparei()

DLL_MAPPING CUTBoolean CUTIL_API cutComparei ( const int *  reference,
const int *  data,
const unsigned int  len 
)

Compare two integer arrays.

Returns
CUTTrue if reference and data are identical, otherwise CUTFalse
Parameters
referencehandle to the reference data / gold image
datahandle to the computed data
lennumber of elements in reference and data

◆ cutCompareL2fe()

DLL_MAPPING CUTBoolean CUTIL_API cutCompareL2fe ( const float *  reference,
const float *  data,
const unsigned int  len,
const float  epsilon 
)

Compare two float arrays using L2-norm with an epsilon tolerance for equality.

Returns
CUTTrue if reference and data are identical, otherwise CUTFalse
Parameters
referencehandle to the reference data / gold image
datahandle to the computed data
lennumber of elements in reference and data
epsilonepsilon to use for the comparison

◆ cutCompareub()

DLL_MAPPING CUTBoolean CUTIL_API cutCompareub ( const unsigned char *  reference,
const unsigned char *  data,
const unsigned int  len 
)

Compare two unsigned char arrays.

Returns
CUTTrue if reference and data are identical, otherwise CUTFalse
Parameters
referencehandle to the reference data / gold image
datahandle to the computed data
lennumber of elements in reference and data

◆ cutCompareube()

DLL_MAPPING CUTBoolean CUTIL_API cutCompareube ( const unsigned char *  reference,
const unsigned char *  data,
const unsigned int  len,
const int  epsilon 
)

Compare two integer arrays witha n epsilon tolerance for equality.

Returns
CUTTrue if reference and data are identical, otherwise CUTFalse
Parameters
referencehandle to the reference data / gold image
datahandle to the computed data
lennumber of elements in reference and data
epsilonepsilon to use for the comparison

◆ cutCreateTimer()

DLL_MAPPING CUTBoolean CUTIL_API cutCreateTimer ( unsigned int *  name)

Timer functionality.

Create a new timer

Returns
CUTTrue if a time has been created, otherwise false
Parameters
nameof the new timer, 0 if the creation failed

◆ cutDeleteTimer()

DLL_MAPPING CUTBoolean CUTIL_API cutDeleteTimer ( unsigned int  name)

Delete a timer.

Returns
CUTTrue if a time has been deleted, otherwise false
Parameters
nameof the timer to delete

◆ cutFindFilePath()

DLL_MAPPING char *CUTIL_API cutFindFilePath ( const char *  filename,
const char *  executablePath 
)

Find the path for a filename.

Returns
the path if succeeded, otherwise 0
Parameters
filenamename of the file
executablePathoptional absolute path of the executable

◆ cutFree()

DLL_MAPPING void CUTIL_API cutFree ( void *  ptr)

Deallocate memory allocated within Cutil.

Parameters
pointerto memory

◆ cutGetAverageTimerValue()

DLL_MAPPING float CUTIL_API cutGetAverageTimerValue ( const unsigned int  name)

Return the average time in milliseconds for timer execution as the total time for the timer dividied by the number of completed (stopped) runs the timer has made.

Excludes the current running time if the timer is currently running.

Parameters
namename of the timer to return the time of

◆ cutGetCmdLineArgumentf()

DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumentf ( const int  argc,
const char **  argv,
const char *  arg_name,
float *  val 
)

Get the value of a command line argument of type float.

Returns
CUTTrue if command line argument arg_name has been given and is of the requested type, otherwise CUTFalse
Parameters
argcargc as passed to main()
argvargv as passed to main()
arg_namename of the command line argument
valvalue of the command line argument

◆ cutGetCmdLineArgumenti()

DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumenti ( const int  argc,
const char **  argv,
const char *  arg_name,
int *  val 
)

Get the value of a command line argument of type int.

Returns
CUTTrue if command line argument arg_name has been given and is of the requested type, otherwise CUTFalse
Parameters
argcargc as passed to main()
argvargv as passed to main()
arg_namename of the command line argument
valvalue of the command line argument

◆ cutGetCmdLineArgumentListstr()

DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumentListstr ( const int  argc,
const char **  argv,
const char *  arg_name,
char **  val,
unsigned int *  len 
)

Get the value of a command line argument list those element are strings.

Returns
CUTTrue if command line argument arg_name has been given and is of the requested type, otherwise CUTFalse
Parameters
argcargc as passed to main()
argvargv as passed to main()
arg_namename of the command line argument
valcommand line argument list
lenlength of the list / number of elements

◆ cutGetCmdLineArgumentstr()

DLL_MAPPING CUTBoolean CUTIL_API cutGetCmdLineArgumentstr ( const int  argc,
const char **  argv,
const char *  arg_name,
char **  val 
)

Get the value of a command line argument of type string.

Returns
CUTTrue if command line argument arg_name has been given and is of the requested type, otherwise CUTFalse
Parameters
argcargc as passed to main()
argvargv as passed to main()
arg_namename of the command line argument
valvalue of the command line argument

◆ cutGetTimerValue()

DLL_MAPPING float CUTIL_API cutGetTimerValue ( const unsigned int  name)

Returns total execution time in milliseconds for the timer over all runs since the last reset or timer creation.

Parameters
namename of the timer to return the time of

◆ cutLoadPGMf()

DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMf ( const char *  file,
float **  data,
unsigned int *  w,
unsigned int *  h 
)

Load PGM image file (with float as data element type)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image
Note
If a NULL pointer is passed to this function and it is initialized withing Cutil then cutFree() has to be used to deallocate the memory

◆ cutLoadPGMi()

DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMi ( const char *  file,
unsigned int **  data,
unsigned int *  w,
unsigned int *  h 
)

Load PGM image file (with unsigned int as data element type)

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutLoadPGMs()

DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMs ( const char *  file,
unsigned short **  data,
unsigned int *  w,
unsigned int *  h 
)

Load PGM image file (with unsigned short as data element type)

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image
Note
If a NULL pointer is passed to this function and it is initialized withing Cutil then cutFree() has to be used to deallocate the memory

◆ cutLoadPGMub()

DLL_MAPPING CUTBoolean CUTIL_API cutLoadPGMub ( const char *  file,
unsigned char **  data,
unsigned int *  w,
unsigned int *  h 
)

Load PGM image file (with unsigned char as data element type)

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutLoadPPM4ub()

DLL_MAPPING CUTBoolean CUTIL_API cutLoadPPM4ub ( const char *  file,
unsigned char **  data,
unsigned int *  w,
unsigned int *  h 
)

Load PPM image file (with unsigned char as data element type), padding 4th component.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutLoadPPMub()

DLL_MAPPING CUTBoolean CUTIL_API cutLoadPPMub ( const char *  file,
unsigned char **  data,
unsigned int *  w,
unsigned int *  h 
)

Load PPM image file (with unsigned char as data element type)

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutReadFileb()

DLL_MAPPING CUTBoolean CUTIL_API cutReadFileb ( const char *  filename,
char **  data,
unsigned int *  len,
bool  verbose = false 
)

Read file \filename containing char / byte data.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filenamename of the source file
datauninitialized pointer, returned initialized and pointing to the data read
lennumber of data elements in data, -1 on error
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutReadFiled()

DLL_MAPPING CUTBoolean CUTIL_API cutReadFiled ( const char *  filename,
double **  data,
unsigned int *  len,
bool  verbose = false 
)

Read file \filename containing double precision floating point data.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filenamename of the source file
datauninitialized pointer, returned initialized and pointing to the data read
lennumber of data elements in data, -1 on error
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutReadFilef()

DLL_MAPPING CUTBoolean CUTIL_API cutReadFilef ( const char *  filename,
float **  data,
unsigned int *  len,
bool  verbose = false 
)

Read file \filename containing single precision floating point data.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filenamename of the source file
datauninitialized pointer, returned initialized and pointing to the data read
lennumber of data elements in data, -1 on error
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutReadFilei()

DLL_MAPPING CUTBoolean CUTIL_API cutReadFilei ( const char *  filename,
int **  data,
unsigned int *  len,
bool  verbose = false 
)

Read file \filename containing integer data.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filenamename of the source file
datauninitialized pointer, returned initialized and pointing to the data read
lennumber of data elements in data, -1 on error
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutReadFileub()

DLL_MAPPING CUTBoolean CUTIL_API cutReadFileub ( const char *  filename,
unsigned char **  data,
unsigned int *  len,
bool  verbose = false 
)

Read file \filename containing unsigned char / byte data.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filenamename of the source file
datauninitialized pointer, returned initialized and pointing to the data read
lennumber of data elements in data, -1 on error
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutReadFileui()

DLL_MAPPING CUTBoolean CUTIL_API cutReadFileui ( const char *  filename,
unsigned int **  data,
unsigned int *  len,
bool  verbose = false 
)

Read file \filename containing unsigned integer data.

Returns
CUTTrue if reading the file succeeded, otherwise false
Parameters
filenamename of the source file
datauninitialized pointer, returned initialized and pointing to the data read
lennumber of data elements in data, -1 on error
Note
If a NULL pointer is passed to this function and it is initialized within Cutil then cutFree() has to be used to deallocate the memory

◆ cutResetTimer()

DLL_MAPPING CUTBoolean CUTIL_API cutResetTimer ( const unsigned int  name)

Resets the timer's counter.

Parameters
namename of the timer to reset.

◆ cutSavePGMf()

DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMf ( const char *  file,
float *  data,
unsigned int  w,
unsigned int  h 
)

Save PGM image file (with float as data element type)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutSavePGMi()

DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMi ( const char *  file,
unsigned int *  data,
unsigned int  w,
unsigned int  h 
)

Save PGM image file (with unsigned int as data element type)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutSavePGMs()

DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMs ( const char *  file,
unsigned short *  data,
unsigned int  w,
unsigned int  h 
)

Save PGM image file (with unsigned short as data element type)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutSavePGMub()

DLL_MAPPING CUTBoolean CUTIL_API cutSavePGMub ( const char *  file,
unsigned char *  data,
unsigned int  w,
unsigned int  h 
)

Save PGM image file (with unsigned char as data element type)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutSavePPM4ub()

DLL_MAPPING CUTBoolean CUTIL_API cutSavePPM4ub ( const char *  file,
unsigned char *  data,
unsigned int  w,
unsigned int  h 
)

Save PPM image file (with unsigned char as data element type, padded to 4 bytes)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutSavePPMub()

DLL_MAPPING CUTBoolean CUTIL_API cutSavePPMub ( const char *  file,
unsigned char *  data,
unsigned int  w,
unsigned int  h 
)

Save PPM image file (with unsigned char as data element type)

Parameters
filename of the image file
datahandle to the data read
wwidth of the image
hheight of the image

◆ cutStartTimer()

DLL_MAPPING CUTBoolean CUTIL_API cutStartTimer ( const unsigned int  name)

Start the time with name name.

Parameters
namename of the timer to start

◆ cutStopTimer()

DLL_MAPPING CUTBoolean CUTIL_API cutStopTimer ( const unsigned int  name)

Stop the time with name name.

Does not reset.

Parameters
namename of the timer to stop

◆ cutWriteFileb()

DLL_MAPPING CUTBoolean CUTIL_API cutWriteFileb ( const char *  filename,
const char *  data,
unsigned int  len,
bool  verbose = false 
)

Write a data file \filename containing char / byte data.

Returns
CUTTrue if writing the file succeeded, otherwise false
Parameters
filenamename of the file to write
datapointer to data to write
lennumber of data elements in data, -1 on error

◆ cutWriteFiled()

DLL_MAPPING CUTBoolean CUTIL_API cutWriteFiled ( const char *  filename,
const float *  data,
unsigned int  len,
const double  epsilon,
bool  verbose = false 
)

Write a data file \filename containing double precision floating point data.

Returns
CUTTrue if writing the file succeeded, otherwise false
Parameters
filenamename of the file to write
datapointer to data to write
lennumber of data elements in data, -1 on error
epsilonepsilon for comparison

◆ cutWriteFilef()

DLL_MAPPING CUTBoolean CUTIL_API cutWriteFilef ( const char *  filename,
const float *  data,
unsigned int  len,
const float  epsilon,
bool  verbose = false 
)

Write a data file \filename containing single precision floating point data.

Returns
CUTTrue if writing the file succeeded, otherwise false
Parameters
filenamename of the file to write
datapointer to data to write
lennumber of data elements in data, -1 on error
epsilonepsilon for comparison

◆ cutWriteFilei()

DLL_MAPPING CUTBoolean CUTIL_API cutWriteFilei ( const char *  filename,
const int *  data,
unsigned int  len,
bool  verbose = false 
)

Write a data file \filename containing integer data.

Returns
CUTTrue if writing the file succeeded, otherwise false
Parameters
filenamename of the file to write
datapointer to data to write
lennumber of data elements in data, -1 on error

◆ cutWriteFileub()

DLL_MAPPING CUTBoolean CUTIL_API cutWriteFileub ( const char *  filename,
const unsigned char *  data,
unsigned int  len,
bool  verbose = false 
)

Write a data file \filename containing unsigned char / byte data.

Returns
CUTTrue if writing the file succeeded, otherwise false
Parameters
filenamename of the file to write
datapointer to data to write
lennumber of data elements in data, -1 on error

◆ cutWriteFileui()

DLL_MAPPING CUTBoolean CUTIL_API cutWriteFileui ( const char *  filename,
const unsigned int *  data,
unsigned int  len,
bool  verbose = false 
)

Write a data file \filename containing unsigned integer data.

Returns
CUTTrue if writing the file succeeded, otherwise false
Parameters
filenamename of the file to write
datapointer to data to write
lennumber of data elements in data, -1 on error