diff options
| author | Gertjan van den Burg <burg@ese.eur.nl> | 2016-12-06 16:26:01 +0100 |
|---|---|---|
| committer | Gertjan van den Burg <burg@ese.eur.nl> | 2016-12-06 16:26:01 +0100 |
| commit | a1d164e6371eaf81a8aaf0be1e1a9b16a1af43fc (patch) | |
| tree | 8fb1d9784d7903fe9e0f188440e52a35c2b0c644 /src/gensvm_kernel.c | |
| parent | add msvmmaj matlab file to git (diff) | |
| download | gensvm-a1d164e6371eaf81a8aaf0be1e1a9b16a1af43fc.tar.gz gensvm-a1d164e6371eaf81a8aaf0be1e1a9b16a1af43fc.zip | |
document undocumented elements
Diffstat (limited to 'src/gensvm_kernel.c')
| -rw-r--r-- | src/gensvm_kernel.c | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/src/gensvm_kernel.c b/src/gensvm_kernel.c index 410ac5f..8f0b6da 100644 --- a/src/gensvm_kernel.c +++ b/src/gensvm_kernel.c @@ -32,6 +32,17 @@ #include "gensvm_kernel.h" #include "gensvm_print.h" +/** + * @brief Copy the kernelparameters from GenModel to GenData + * + * @details + * This is a little utility function to copy the kernel type and kernel + * parameters from a GenModel struct to a GenData struct. + * + * @param[in] model a GenModel struct + * @param[in] data a GenData struct + * + */ void gensvm_kernel_copy_kernelparam_to_data(struct GenModel *model, struct GenData *data) { @@ -209,12 +220,13 @@ void gensvm_kernel_compute(struct GenModel *model, struct GenData *data, * uses the highest precision eigenvalues, twice the underflow threshold (see * dsyevx documentation). * - * @param[in] K the kernel matrix - * @param[in] n the dimension of the kernel matrix - * @param[in] cutoff mimimum ratio of eigenvalue to largest - * eigenvalue for the eigenvector to be included - * @param[out] P on exit contains the eigenvectors - * @param[out] Sigma on exit contains the eigenvalues + * @param[in] K the kernel matrix + * @param[in] n the dimension of the kernel matrix + * @param[in] cutoff mimimum ratio of eigenvalue to largest + * eigenvalue for the eigenvector to be + * included + * @param[out] P_ret on exit contains the eigenvectors + * @param[out] Sigma_ret on exit contains the eigenvalues * * @return the number of eigenvalues kept */ |