From: Paul Brossier <piem@piem.org>
Date: Mon, 28 Jan 2019 21:58:11 +0000 (+0100)
Subject: [tensor] improve documentation, add todos
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=ddd124af2ce0e1664d2233c3f58eeeff7d0f24a5;p=aubio.git

[tensor] improve documentation, add todos
---

diff --git a/src/ai/tensor.h b/src/ai/tensor.h
index 44a14c23..a6fe03b2 100644
--- a/src/ai/tensor.h
+++ b/src/ai/tensor.h
@@ -21,16 +21,22 @@
 #ifndef AUBIO_TENSOR_H
 #define AUBIO_TENSOR_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 /** \file
 
   Tensor for real-valued data.
 
 */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Maximum number of dimensions
+
+  This is defined as a constant so that ::aubio_tensor_t allocated
+  on the stack can be manipulated.
+
+ */
 #define AUBIO_TENSOR_MAXDIM 10
 
 /** Tensor for real-valued data
@@ -38,6 +44,11 @@ extern "C" {
   This object holds a tensor of real-valued data, ::smpl_t, with up to
   AUBIO_TENSOR_MAXDIM dimentsions.
 
+  Todo:
+  - add array of strides
+  - add accessors macros
+  - consider removing data
+
 */
 typedef struct
 {