.. index:: pair: struct; dnnl_resampling_desc_t
.. _doxid-structdnnl__resampling__desc__t:

struct dnnl_resampling_desc_t
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A descriptor of resampling operation. :ref:`More...<details-structdnnl__resampling__desc__t>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <dnnl_types.h>
	
	struct dnnl_resampling_desc_t
	{
		// fields
	
		:ref:`dnnl_primitive_kind_t<doxid-group__dnnl__api__primitives__common_1ga9878f4795e53ad8443e5c0a29e53286a>` :ref:`primitive_kind<doxid-structdnnl__resampling__desc__t_1ae99b0da26b53a88c1215670ffaed2894>`;
		:ref:`dnnl_prop_kind_t<doxid-group__dnnl__api__primitives__common_1gae3c1f22ae55645782923fbfd8b07d0c4>` :ref:`prop_kind<doxid-structdnnl__resampling__desc__t_1a378e8d34f696d7fa4eb4d6dbea9f84af>`;
		:ref:`dnnl_alg_kind_t<doxid-group__dnnl__api__primitives__common_1ga96946c805f6c4922c38c37049ab95d23>` :ref:`alg_kind<doxid-structdnnl__resampling__desc__t_1a21f709d07bd16a1925d2d7e1ef643677>`;
		:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` :ref:`src_desc<doxid-structdnnl__resampling__desc__t_1ad91088d05bf45bdc972e6a6a0d6ecd52>`;
		:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` :ref:`diff_src_desc<doxid-structdnnl__resampling__desc__t_1aa67d5cc59034540ea62ddc469729d81c>`;
		:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` :ref:`dst_desc<doxid-structdnnl__resampling__desc__t_1aaa68f8bd861f6d0b5cf3fd2b9736e7fa>`;
		:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` :ref:`diff_dst_desc<doxid-structdnnl__resampling__desc__t_1a0f5d6be9d7a3754ec53679f0bfd4e374>`;
		float :ref:`factors<doxid-structdnnl__resampling__desc__t_1ab43b1987bbffd7d6eca04301d8fe1643>`[DNNL_MAX_NDIMS];
	};
.. _details-structdnnl__resampling__desc__t:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

A descriptor of resampling operation.

Fields
------

.. index:: pair: variable; primitive_kind
.. _doxid-structdnnl__resampling__desc__t_1ae99b0da26b53a88c1215670ffaed2894:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_primitive_kind_t<doxid-group__dnnl__api__primitives__common_1ga9878f4795e53ad8443e5c0a29e53286a>` primitive_kind

The kind of primitive.

Used for self-identifying the primitive descriptor. Must be :ref:`dnnl_resampling <doxid-group__dnnl__api__primitives__common_1gga9878f4795e53ad8443e5c0a29e53286aa7ab1ead09194e7acb0813c953e66988f>`.

.. index:: pair: variable; prop_kind
.. _doxid-structdnnl__resampling__desc__t_1a378e8d34f696d7fa4eb4d6dbea9f84af:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_prop_kind_t<doxid-group__dnnl__api__primitives__common_1gae3c1f22ae55645782923fbfd8b07d0c4>` prop_kind

The kind of propagation.

Possible values: :ref:`dnnl_forward_training <doxid-group__dnnl__api__primitives__common_1ggae3c1f22ae55645782923fbfd8b07d0c4a992e03bebfe623ac876b3636333bbce0>`, :ref:`dnnl_forward_inference <doxid-group__dnnl__api__primitives__common_1ggae3c1f22ae55645782923fbfd8b07d0c4a2f77a568a675dec649eb0450c997856d>`, :ref:`dnnl_backward_data <doxid-group__dnnl__api__primitives__common_1ggae3c1f22ae55645782923fbfd8b07d0c4a524dd6cb2ed9680bbd170ba15261d218>`,

.. index:: pair: variable; alg_kind
.. _doxid-structdnnl__resampling__desc__t_1a21f709d07bd16a1925d2d7e1ef643677:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_alg_kind_t<doxid-group__dnnl__api__primitives__common_1ga96946c805f6c4922c38c37049ab95d23>` alg_kind

The kind of the resampling algorithm.

Possible values: :ref:`dnnl_resampling_nearest <doxid-group__dnnl__api__primitives__common_1gga96946c805f6c4922c38c37049ab95d23af3f4351e11d0792cdfddff5e12e806be>`, :ref:`dnnl_resampling_linear <doxid-group__dnnl__api__primitives__common_1gga96946c805f6c4922c38c37049ab95d23a1db5bfa7000fa71a7b8bce1c3497ae1b>`.

.. index:: pair: variable; src_desc
.. _doxid-structdnnl__resampling__desc__t_1ad91088d05bf45bdc972e6a6a0d6ecd52:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` src_desc

Source memory descriptor.

.. index:: pair: variable; diff_src_desc
.. _doxid-structdnnl__resampling__desc__t_1aa67d5cc59034540ea62ddc469729d81c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` diff_src_desc

Source gradient memory descriptor.

.. index:: pair: variable; dst_desc
.. _doxid-structdnnl__resampling__desc__t_1aaa68f8bd861f6d0b5cf3fd2b9736e7fa:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` dst_desc

Destination memory descriptor.

.. index:: pair: variable; diff_dst_desc
.. _doxid-structdnnl__resampling__desc__t_1a0f5d6be9d7a3754ec53679f0bfd4e374:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>` diff_dst_desc

Destination gradient memory descriptor.

.. index:: pair: variable; factors
.. _doxid-structdnnl__resampling__desc__t_1ab43b1987bbffd7d6eca04301d8fe1643:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	float factors[DNNL_MAX_NDIMS]

Resampling factor in each spatial dimension.