From a1d164e6371eaf81a8aaf0be1e1a9b16a1af43fc Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Tue, 6 Dec 2016 16:26:01 +0100 Subject: document undocumented elements --- include/gensvm_globals.h | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) (limited to 'include/gensvm_globals.h') diff --git a/include/gensvm_globals.h b/include/gensvm_globals.h index 7c3b68e..75b13d5 100644 --- a/include/gensvm_globals.h +++ b/include/gensvm_globals.h @@ -48,24 +48,45 @@ #include #include +/** + * Maximum line length of files that are read into GenSVM. + */ #define MAX_LINE_LENGTH 1024 #ifndef MIN_MAX_DEFINE -#define MIN_MAX_DEFINE -#define maximum(a, b) (a) > (b) ? (a) : (b) -#define minimum(a, b) (a) < (b) ? (a) : (b) + /** + * Flag to check if minimum/maximum macro's are already defined. This can be + * useful when linking. + */ + #define MIN_MAX_DEFINE + /** + * Macro for taking the maximum of two arguments. + */ + #define maximum(a, b) (a) > (b) ? (a) : (b) + /** + * Macro for taking the minimum of two arguments. + */ + #define minimum(a, b) (a) < (b) ? (a) : (b) #endif -// Set a matrix element (RowMajor) +/** + * Macro for setting a matrix element (RowMajor order) + */ #define matrix_set(M, cols, i, j, val) M[(i)*(cols)+j] = val -// Get a matrix element (RowMajor) +/** + * Macro for getting a matrix element (RowMajor order) + */ #define matrix_get(M, cols, i, j) M[(i)*(cols)+j] -// Add to a matrix element (RowMajor) +/** + * Macro for adding to a matrix element (RowMajor order) + */ #define matrix_add(M, cols, i, j, val) M[(i)*(cols)+j] += val -// Multiply a matrix element (RowMajor) +/** + * Macro for multiplying a matrix element (RowMajor order) + */ #define matrix_mul(M, cols, i, j, val) M[(i)*(cols)+j] *= val #endif -- cgit v1.2.3