Functions
arm_cmsis_nn_status	arm_avgpool_s16 (const cmsis_nn_context ctx, const cmsis_nn_pool_params pool_params, const cmsis_nn_dims input_dims, const int16_t src, const cmsis_nn_dims filter_dims, const cmsis_nn_dims output_dims, int16_t *dst)
	s16 average pooling function. More...

int32_t	arm_avgpool_s16_get_buffer_size (const int output_x, const int ch_src)
	Get the required buffer size for S16 average pooling function. More...

arm_cmsis_nn_status	arm_avgpool_s8 (const cmsis_nn_context ctx, const cmsis_nn_pool_params pool_params, const cmsis_nn_dims input_dims, const int8_t src, const cmsis_nn_dims filter_dims, const cmsis_nn_dims output_dims, int8_t *dst)
	s8 average pooling function. More...

int32_t	arm_avgpool_s8_get_buffer_size (const int output_x, const int ch_src)
	Get the required buffer size for S8 average pooling function. More...

arm_cmsis_nn_status	arm_max_pool_s16 (const cmsis_nn_context ctx, const cmsis_nn_pool_params pool_params, const cmsis_nn_dims input_dims, const int16_t src, const cmsis_nn_dims filter_dims, const cmsis_nn_dims output_dims, int16_t *dst)
	s16 max pooling function. More...

arm_cmsis_nn_status	arm_max_pool_s8 (const cmsis_nn_context ctx, const cmsis_nn_pool_params pool_params, const cmsis_nn_dims input_dims, const int8_t src, const cmsis_nn_dims filter_dims, const cmsis_nn_dims output_dims, int8_t *dst)
	s8 max pooling function. More...

Description

Perform max and average pooling operations

Function Documentation

arm_cmsis_nn_status arm_avgpool_s16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int16_t *	input_data,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int16_t *	output_data
	)

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer ,if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used.
[in]	input_data	Input (activation) data pointer. Data type: int16
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	output_data	Output data pointer. Data type: int16

Returns: The function returns ARM_CMSIS_NN_SUCCESS - Successful operation ARM_CMSIS_NN_ARG_ERROR - In case of invalid arguments

int32_t arm_avgpool_s16_get_buffer_size	(	const int	dim_dst_width,
		const int	ch_src
	)

Parameters

[in]	dim_dst_width	output tensor dimension
[in]	ch_src	number of input tensor channels

arm_cmsis_nn_status arm_avgpool_s8	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int8_t *	input_data,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int8_t *	output_data
	)

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer ,if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used.
[in]	input_data	Input (activation) data pointer. Data type: int8
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	output_data	Output data pointer. Data type: int8

int32_t arm_avgpool_s8_get_buffer_size	(	const int	dim_dst_width,
		const int	ch_src
	)

Parameters

[in]	dim_dst_width	output tensor dimension
[in]	ch_src	number of input tensor channels

arm_cmsis_nn_status arm_max_pool_s16	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int16_t *	src,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int16_t *	dst
	)

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer ,if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used.
[in]	src	Input (activation) data pointer. The input tensor must not overlap with the output tensor. Data type: int16
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	dst	Output data pointer. Data type: int16

arm_cmsis_nn_status arm_max_pool_s8	(	const cmsis_nn_context *	ctx,
		const cmsis_nn_pool_params *	pool_params,
		const cmsis_nn_dims *	input_dims,
		const int8_t *	input_data,
		const cmsis_nn_dims *	filter_dims,
		const cmsis_nn_dims *	output_dims,
		int8_t *	output_data
	)

Parameters

[in,out]	ctx	Function context (e.g. temporary buffer). Check the function definition file to see if an additional buffer is required. Optional function {API}_get_buffer_size() provides the buffer size if an additional buffer is required. The caller is expected to clear the buffer ,if applicable, for security reasons.
[in]	pool_params	Pooling parameters
[in]	input_dims	Input (activation) tensor dimensions. Format: [H, W, C_IN] Argument 'N' is not used.
[in]	input_data	Input (activation) data pointer. The input tensor must not overlap with the output tensor. Data type: int8
[in]	filter_dims	Filter tensor dimensions. Format: [H, W] Argument N and C are not used.
[in]	output_dims	Output tensor dimensions. Format: [H, W, C_OUT] Argument N is not used. C_OUT equals C_IN.
[in,out]	output_data	Output data pointer. Data type: int8