From 536cf112e98af8595faff1924b5ccac8d1b5e6bd Mon Sep 17 00:00:00 2001
From: Guillaume Sylvand <guillaume.sylvand@airbus.com>
Date: Wed, 7 Sep 2016 14:36:12 +0000
Subject: [PATCH] Add some comments in matrix generation routines
---
compute/pzplghe.c | 2 +-
compute/pzplghe2.c | 2 +-
compute/pzplgsy.c | 2 +-
compute/pzplgsy2.c | 2 +-
compute/pzplrnt.c | 2 +-
compute/zplghe.c | 6 +++---
compute/zplghe2.c | 6 +++---
compute/zplgsy.c | 6 +++---
compute/zplgsy2.c | 6 +++---
coreblas/compute/core_zplghe.c | 1 +
coreblas/compute/core_zplgsy.c | 2 ++
coreblas/compute/core_zplrnt.c | 1 +
runtime/starpu/codelets/codelet_zplghe.c | 3 +++
runtime/starpu/codelets/codelet_zplgsy.c | 2 ++
runtime/starpu/codelets/codelet_zplrnt.c | 2 ++
15 files changed, 28 insertions(+), 17 deletions(-)
diff --git a/compute/pzplghe.c b/compute/pzplghe.c
index a247e3e7d..4ad0c6244 100644
--- a/compute/pzplghe.c
+++ b/compute/pzplghe.c
@@ -30,7 +30,7 @@
#define A(m,n) A, m, n
/***************************************************************************//**
- * Parallel tile Cholesky factorization - dynamic scheduling
+ * morse_pzplghe - Generate a random hermitian (positive definite if 'bump' is large enough) matrix by tiles.
**/
void morse_pzplghe( double bump, MORSE_desc_t *A, unsigned long long int seed,
MORSE_sequence_t *sequence, MORSE_request_t *request )
diff --git a/compute/pzplghe2.c b/compute/pzplghe2.c
index 439e3fc12..558a7f615 100644
--- a/compute/pzplghe2.c
+++ b/compute/pzplghe2.c
@@ -32,7 +32,7 @@
#define A(m,n) A, m, n
/***************************************************************************//**
- * Parallel tile Cholesky factorization - dynamic scheduling - half generation
+ * morse_pzplghe - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
**/
void morse_pzplghe2( double bump, MORSE_desc_t *A, unsigned long long int seed,
MORSE_enum uplo, MORSE_sequence_t *sequence,
diff --git a/compute/pzplgsy.c b/compute/pzplgsy.c
index f2703c0a5..0a1f2883c 100644
--- a/compute/pzplgsy.c
+++ b/compute/pzplgsy.c
@@ -30,7 +30,7 @@
#define A(m,n) A, m, n
/***************************************************************************//**
- * Parallel tile Cholesky factorization - dynamic scheduling
+ * morse_pzplgsy - Generate a random symmetric (positive definite if 'bump' is large enough) matrix by tiles.
**/
void morse_pzplgsy( MORSE_Complex64_t bump, MORSE_desc_t *A, unsigned long long int seed,
MORSE_sequence_t *sequence, MORSE_request_t *request )
diff --git a/compute/pzplgsy2.c b/compute/pzplgsy2.c
index 6d44848ff..1277bc92a 100644
--- a/compute/pzplgsy2.c
+++ b/compute/pzplgsy2.c
@@ -32,7 +32,7 @@
#define A(m,n) A, m, n
/***************************************************************************//**
- * Parallel tile random 'half' simetrical matrix generation- dynamic scheduling
+ * morse_pzplgsy2 - Generate a random symmetric (positive definite if 'bump' is large enough) half-matrix by tiles.
**/
void morse_pzplgsy2( MORSE_Complex64_t bump, MORSE_desc_t *A,
unsigned long long int seed, MORSE_enum uplo,
diff --git a/compute/pzplrnt.c b/compute/pzplrnt.c
index f0b557626..29ff7e47e 100644
--- a/compute/pzplrnt.c
+++ b/compute/pzplrnt.c
@@ -30,7 +30,7 @@
#define A(m, n) A, m, n
/***************************************************************************//**
- * Parallel tile Cholesky factorization - dynamic scheduling
+ * morse_pzplghe - Generate a random matrix by tiles.
**/
void morse_pzplrnt( MORSE_desc_t *A, unsigned long long int seed,
MORSE_sequence_t *sequence, MORSE_request_t *request )
diff --git a/compute/zplghe.c b/compute/zplghe.c
index 70c0da81d..b446437f1 100644
--- a/compute/zplghe.c
+++ b/compute/zplghe.c
@@ -32,7 +32,7 @@
*
* @ingroup MORSE_Complex64_t
*
- * MORSE_zplghe - Generate a random hermitian matrix by tiles.
+ * MORSE_zplghe - Generate a random hermitian (positive definite if 'bump' is large enough) matrix by tiles.
*
*******************************************************************************
*
@@ -128,7 +128,7 @@ int MORSE_zplghe( double bump, int N,
*
* @ingroup MORSE_Complex64_t_Tile
*
- * MORSE_zplghe_Tile - Generate a random hermitian matrix by tiles.
+ * MORSE_zplghe_Tile - Generate a random hermitian (positive definite if 'bump' is large enough) matrix by tiles.
* Tile equivalent of MORSE_zplghe().
* Operates on matrices stored by tiles.
* All matrices are passed through descriptors.
@@ -187,7 +187,7 @@ int MORSE_zplghe_Tile( double bump, MORSE_desc_t *A,
*
* @ingroup MORSE_Complex64_t_Tile_Async
*
- * MORSE_zplghe_Tile_Async - Generate a random hermitian matrix by tiles.
+ * MORSE_zplghe_Tile_Async - Generate a random hermitian (positive definite if 'bump' is large enough) matrix by tiles.
* Non-blocking equivalent of MORSE_zplghe_Tile().
* May return before the computation is finished.
* Allows for pipelining of operations at runtime.
diff --git a/compute/zplghe2.c b/compute/zplghe2.c
index 689e2d67c..25c87ac43 100644
--- a/compute/zplghe2.c
+++ b/compute/zplghe2.c
@@ -34,7 +34,7 @@
*
* @ingroup MORSE_Complex64_t
*
- * MORSE_zplghe2 - One 'half' of a random hermitian matrix by tiles.
+ * MORSE_zplghe2 - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
*
*******************************************************************************
*
@@ -132,7 +132,7 @@ int MORSE_zplghe2( double bump, int N,
*
* @ingroup MORSE_Complex64_t_Tile
*
- * MORSE_zplghe2_Tile - Generate 'half' of a random hermitian matrix by tiles.
+ * MORSE_zplghe2_Tile - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
* Tile equivalent of MORSE_zplghe2().
* Operates on matrices stored by tiles.
* All matrices are passed through descriptors.
@@ -193,7 +193,7 @@ int MORSE_zplghe2_Tile( double bump, MORSE_desc_t *A,
*
* @ingroup MORSE_Complex64_t_Tile_Async
*
- * MORSE_zplghe2_Tile_Async - Generate a half random hermitian matrix by tiles.
+ * MORSE_zplghe2_Tile_Async - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
* Non-blocking equivalent of MORSE_zplghe2_Tile().
* May return before the computation is finished.
* Allows for pipelining of operations at runtime.
diff --git a/compute/zplgsy.c b/compute/zplgsy.c
index c20e3186b..bbf5aaa48 100644
--- a/compute/zplgsy.c
+++ b/compute/zplgsy.c
@@ -32,7 +32,7 @@
*
* @ingroup MORSE_Complex64_t
*
- * MORSE_zplgsy - Generate a random hermitian matrix by tiles.
+ * MORSE_zplgsy - Generate a random symmetric (positive definite if 'bump' is large enough) matrix by tiles.
*
*******************************************************************************
*
@@ -128,7 +128,7 @@ int MORSE_zplgsy( MORSE_Complex64_t bump, int N,
*
* @ingroup MORSE_Complex64_t_Tile
*
- * MORSE_zplgsy_Tile - Generate a random hermitian matrix by tiles.
+ * MORSE_zplgsy_Tile - Generate a random symmetric (positive definite if 'bump' is large enough) matrix by tiles.
* Tile equivalent of MORSE_zplgsy().
* Operates on matrices stored by tiles.
* All matrices are passed through descriptors.
@@ -187,7 +187,7 @@ int MORSE_zplgsy_Tile( MORSE_Complex64_t bump, MORSE_desc_t *A,
*
* @ingroup MORSE_Complex64_t_Tile_Async
*
- * MORSE_zplgsy_Tile_Async - Generate a random hermitian matrix by tiles.
+ * MORSE_zplgsy_Tile_Async - Generate a random symmetric (positive definite if 'bump' is large enough) matrix by tiles.
* Non-blocking equivalent of MORSE_zplgsy_Tile().
* May return before the computation is finished.
* Allows for pipelining of operations at runtime.
diff --git a/compute/zplgsy2.c b/compute/zplgsy2.c
index 05b2682c7..0fce99c8e 100644
--- a/compute/zplgsy2.c
+++ b/compute/zplgsy2.c
@@ -34,7 +34,7 @@
*
* @ingroup MORSE_Complex64_t
*
- * MORSE_zplgsy2 - Generate 'half' of a random simetrical matrix by tiles.
+ * MORSE_zplgsy2 - Generate a random symmetric (positive definite if 'bump' is large enough) half-matrix by tiles.
*
*******************************************************************************
*
@@ -132,7 +132,7 @@ int MORSE_zplgsy2( MORSE_Complex64_t bump, int N,
*
* @ingroup MORSE_Complex64_t_Tile
*
- * MORSE_zplgsy2_Tile - Generate 'half' of a random simetrical matrix by tiles.
+ * MORSE_zplgsy2_Tile - Generate a random symmetric (positive definite if 'bump' is large enough) half-matrix by tiles.
* Tile equivalent of MORSE_zplgsy2().
* Operates on matrices stored by tiles.
* All matrices are passed through descriptors.
@@ -193,7 +193,7 @@ int MORSE_zplgsy2_Tile( MORSE_Complex64_t bump, MORSE_desc_t *A,
*
* @ingroup MORSE_Complex64_t_Tile_Async
*
- * MORSE_zplgsy2_Tile_Async - Generate a random hermitian matrix by tiles.
+ * MORSE_zplgsy2_Tile_Async - Generate a random symmetric (positive definite if 'bump' is large enough) half-matrix by tiles.
* Non-blocking equivalent of MORSE_zplgsy2_Tile().
* May return before the computation is finished.
* Allows for pipelining of operations at runtime.
diff --git a/coreblas/compute/core_zplghe.c b/coreblas/compute/core_zplghe.c
index 5f513062f..097d63ad4 100644
--- a/coreblas/compute/core_zplghe.c
+++ b/coreblas/compute/core_zplghe.c
@@ -71,6 +71,7 @@ Rnd64_jump(unsigned long long int n, unsigned long long int seed ) {
return ran;
}
+// CORE_zplghe - Generate a tile for random hermitian (positive definite if bump is large enough) matrix.
void CORE_zplghe( double bump, int m, int n, MORSE_Complex64_t *A, int lda,
int bigM, int m0, int n0, unsigned long long int seed )
diff --git a/coreblas/compute/core_zplgsy.c b/coreblas/compute/core_zplgsy.c
index 7f2ba6027..8a0dbe15d 100644
--- a/coreblas/compute/core_zplgsy.c
+++ b/coreblas/compute/core_zplgsy.c
@@ -72,6 +72,8 @@ Rnd64_jump(unsigned long long int n, unsigned long long int seed ) {
}
+// CORE_zplgsy - Generate a tile for random symmetric (positive definite if 'bump' is large enough) matrix.
+
void CORE_zplgsy( MORSE_Complex64_t bump, int m, int n, MORSE_Complex64_t *A, int lda,
int bigM, int m0, int n0, unsigned long long int seed )
{
diff --git a/coreblas/compute/core_zplrnt.c b/coreblas/compute/core_zplrnt.c
index 2a605de4b..f3aba6370 100644
--- a/coreblas/compute/core_zplrnt.c
+++ b/coreblas/compute/core_zplrnt.c
@@ -71,6 +71,7 @@ Rnd64_jump(unsigned long long int n, unsigned long long int seed ) {
return ran;
}
+// CORE_zplrnt - Generate a tile for random matrix.
void CORE_zplrnt( int m, int n, MORSE_Complex64_t *A, int lda,
int bigM, int m0, int n0, unsigned long long int seed )
diff --git a/runtime/starpu/codelets/codelet_zplghe.c b/runtime/starpu/codelets/codelet_zplghe.c
index 73df1e374..0acfb4174 100644
--- a/runtime/starpu/codelets/codelet_zplghe.c
+++ b/runtime/starpu/codelets/codelet_zplghe.c
@@ -31,6 +31,8 @@
#include "runtime/starpu/include/morse_starpu.h"
#include "runtime/starpu/include/runtime_codelet_z.h"
+// MORSE_TASK_zplghe - Generate a tile for random hermitian (positive definite if bump is large enough) matrix.
+
void MORSE_TASK_zplghe( MORSE_option_t *options,
double bump, int m, int n, MORSE_desc_t *A, int Am, int An, int lda,
int bigM, int m0, int n0, unsigned long long int seed )
@@ -58,6 +60,7 @@ void MORSE_TASK_zplghe( MORSE_option_t *options,
}
}
+// cl_zplghe_cpu_func - Generate a tile for random hermitian (positive definite if bump is large enough) matrix.
static void cl_zplghe_cpu_func(void *descr[], void *cl_arg)
{
diff --git a/runtime/starpu/codelets/codelet_zplgsy.c b/runtime/starpu/codelets/codelet_zplgsy.c
index 62e0f86df..39c417397 100644
--- a/runtime/starpu/codelets/codelet_zplgsy.c
+++ b/runtime/starpu/codelets/codelet_zplgsy.c
@@ -32,6 +32,7 @@
#include "runtime/starpu/include/runtime_codelet_z.h"
+// MORSE_TASK_zplgsy - Generate a tile for random symmetric (positive definite if 'bump' is large enough) matrix.
void MORSE_TASK_zplgsy( MORSE_option_t *options,
MORSE_Complex64_t bump, int m, int n, MORSE_desc_t *A, int Am, int An, int lda,
@@ -60,6 +61,7 @@ void MORSE_TASK_zplgsy( MORSE_option_t *options,
}
}
+// cl_zplgsy_cpu_func - Generate a tile for random symmetric (positive definite if 'bump' is large enough) matrix.
static void cl_zplgsy_cpu_func(void *descr[], void *cl_arg)
{
diff --git a/runtime/starpu/codelets/codelet_zplrnt.c b/runtime/starpu/codelets/codelet_zplrnt.c
index a5c0f2dec..75ccff6a1 100644
--- a/runtime/starpu/codelets/codelet_zplrnt.c
+++ b/runtime/starpu/codelets/codelet_zplrnt.c
@@ -32,6 +32,7 @@
#include "runtime/starpu/include/runtime_codelet_z.h"
+// MORSE_TASK_zplrnt - Generate a tile for random matrix.
void MORSE_TASK_zplrnt( MORSE_option_t *options,
int m, int n, MORSE_desc_t *A, int Am, int An, int lda,
@@ -58,6 +59,7 @@ void MORSE_TASK_zplrnt( MORSE_option_t *options,
}
}
+// cl_zplrnt_cpu_func - Generate a tile for random matrix.
static void cl_zplrnt_cpu_func(void *descr[], void *cl_arg)
{
--
GitLab