From 0cc025358af341b7e9757e2b9ce5eb0b09af7b2f Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 14 Oct 2016 19:00:33 +0200 Subject: documentation fixes --- src/gensvm_kernel.c | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) (limited to 'src/gensvm_kernel.c') diff --git a/src/gensvm_kernel.c b/src/gensvm_kernel.c index 97328d2..67c063d 100644 --- a/src/gensvm_kernel.c +++ b/src/gensvm_kernel.c @@ -98,6 +98,21 @@ void gensvm_kernel_postprocess(struct GenModel *model, free(K2); } +/** + * @brief Compute the kernel matrix + * + * @details + * This function computes the kernel matrix of a data matrix based on the + * requested kernel type and the kernel parameters. The potential types of + * kernel functions are document in KernelType. This function uses a naive + * multiplication and computes the entire upper triangle of the kernel matrix, + * then copies this over to the lower triangle. + * + * @param[in] model a GenModel structure with the model + * @param[in] data a GenData structure with the data + * @param[out] K an nxn preallocated kernel matrix + * + */ void gensvm_make_kernel(struct GenModel *model, struct GenData *data, double *K) { @@ -132,11 +147,17 @@ void gensvm_make_kernel(struct GenModel *model, struct GenData *data, } /** - * @brief Find the (reduced) eigendecomposition of a kernel matrix. + * @brief Find the (reduced) eigendecomposition of a kernel matrix + * + * @todo + * Document this function * - * @details. - * tbd + * @param[in] K + * @param[in] n + * @param[out] P + * @param[out] Sigma * + * @return */ long gensvm_make_eigen(double *K, long n, double **P, double **Sigma) { -- cgit v1.2.3