Changeset 514a87c


Ignore:
Timestamp:
Dec 29, 2021, 5:52:01 PM (3 weeks ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/crepe
Children:
8429515
Parents:
53849b0
git-author:
Paul Brossier <piem@piem.org> (01/29/19 02:59:00)
git-committer:
Paul Brossier <piem@piem.org> (12/29/21 17:52:01)
Message:

[maxpool1d] add basic documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/ai/maxpool1d.h

    r53849b0 r514a87c  
    2222#define AUBIO_MAXPOOL1D_H
    2323
     24/** \file
     25
     26  Max pooling layer (1D)
     27
     28*/
     29
    2430#ifdef __cplusplus
    2531extern "C" {
    2632#endif
    2733
     34/** maxpool1d layer */
    2835typedef struct _aubio_maxpool1d_t aubio_maxpool1d_t;
    2936
     37/** create a new maxpool1d layer
     38
     39  \param pool_size  size of the pooling windows
     40
     41  \return new ::aubio_maxpool2d_t layer
     42
     43*/
    3044aubio_maxpool1d_t *new_aubio_maxpool1d(uint_t pool_size[1]);
    3145
     46/** get output shape
     47
     48  \param t      layer
     49  \param input  input tensor
     50  \param shape  output shape
     51
     52  \return 0 on success, non-zero otherwise
     53
     54*/
    3255uint_t aubio_maxpool1d_get_output_shape(aubio_maxpool1d_t *t,
    3356        aubio_tensor_t *input, uint_t *shape);
    3457
     58/** compute layer output
     59
     60  \param    t               layer
     61  \param    input_tensor    input tensor
     62  \param    output_tensor   output tensor
     63
     64*/
    3565void aubio_maxpool1d_do(aubio_maxpool1d_t *t,
    3666        aubio_tensor_t *input_tensor,
    37         aubio_tensor_t *activations);
     67        aubio_tensor_t *output_tensor);
    3868
     69/** destroy layer
     70
     71  \param t      layer to destroy
     72
     73*/
    3974void del_aubio_maxpool1d(aubio_maxpool1d_t *t);
    4075
Note: See TracChangeset for help on using the changeset viewer.