.. index:: pair: struct; dnnl::shuffle_forward::desc
.. _doxid-structdnnl_1_1shuffle__forward_1_1desc:

struct dnnl::shuffle_forward::desc
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Descriptor for a shuffle forward propagation primitive. :ref:`More...<details-structdnnl_1_1shuffle__forward_1_1desc>`


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

	#include <dnnl.hpp>
	
	struct desc
	{
		// fields
	
		:ref:`dnnl_shuffle_desc_t<doxid-structdnnl__shuffle__desc__t>` :target:`data<doxid-structdnnl_1_1shuffle__forward_1_1desc_1a386950af44439ac463dd773726f3614f>`;

		// construction
	
		:ref:`desc<doxid-structdnnl_1_1shuffle__forward_1_1desc_1a7b52a213fb4a9da6170965dba994bf27>`(
			:ref:`prop_kind<doxid-group__dnnl__api__attributes_1gac7db48f6583aa9903e54c2a39d65438f>` aprop_kind,
			const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& data_desc,
			int axis,
			int group_size
			);
	};
.. _details-structdnnl_1_1shuffle__forward_1_1desc:

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

Descriptor for a shuffle forward propagation primitive.

Construction
------------

.. index:: pair: function; desc
.. _doxid-structdnnl_1_1shuffle__forward_1_1desc_1a7b52a213fb4a9da6170965dba994bf27:

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

	desc(
		:ref:`prop_kind<doxid-group__dnnl__api__attributes_1gac7db48f6583aa9903e54c2a39d65438f>` aprop_kind,
		const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& data_desc,
		int axis,
		int group_size
		)

Constructs a descriptor for a shuffle forward propagation primitive.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- aprop_kind

		- Propagation kind. Possible values are :ref:`dnnl::prop_kind::forward_training <doxid-group__dnnl__api__attributes_1ggac7db48f6583aa9903e54c2a39d65438fa24775787fab8f13aa4809e1ce8f82aeb>`, and :ref:`dnnl::prop_kind::forward_inference <doxid-group__dnnl__api__attributes_1ggac7db48f6583aa9903e54c2a39d65438fa3b9fad4f80d45368f856b5403198ac4c>`.

	*
		- data_desc

		- Source and destination memory descriptor.

	*
		- axis

		- The axis along which the data is shuffled.

	*
		- group_size

		- Shuffle group size.