Changeset 40520ea

Timestamp:

Jan 2, 2019, 10:51:35 PM (5 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/cnn_org, feature/crepe_org

Children:

f5ea4fb

Parents:

50d7afe

Message:

[tensor] add buffer field, improve documentation

File:

• src/ai/tensor.h (modified) (1 diff)

src/ai/tensor.h

@@ -26 +26 @@
 #endif
 
-typedef struct {
-  uint_t ndim;            //< number of dimensions
-  uint_t shape[8];        //< dimensions array
-  smpl_t **data;          //< buffer of values
-  uint_t size;            //< total number of elements
+/** \file
+
+  Tensor for real-valued data.
+
+*/
+
+#define AUBIO_TENSOR_MAXDIM 10
+
+/** Tensor for real-valued data
+
+  This object holds a tensor of real-valued data, ::smpl_t, with up to
+  AUBIO_TENSOR_MAXDIM dimentsions.
+
+*/
+typedef struct
+{
+  uint_t ndim;     /**< number of dimensions */
+  uint_t shape[AUBIO_TENSOR_MAXDIM]; /**< dimensions array */
+  uint_t size;     /**< total number of elements */
+  smpl_t *buffer;  /**< buffer of values */
+  smpl_t **data;   /**< pointer to rows, or NULL when subtensor */
 } aubio_tensor_t;