.. index:: pair: struct; dnnl::lbr_gru_forward::primitive_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc: struct dnnl::lbr_gru_forward::primitive_desc ============================================ .. toctree:: :hidden: Overview ~~~~~~~~ Primitive descriptor for an LBR GRU forward propagation primitive. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include struct primitive_desc: public :ref:`dnnl::rnn_primitive_desc_base` { // construction :ref:`primitive_desc`(); :ref:`primitive_desc`( const :ref:`desc`& adesc, const :ref:`engine`& aengine, bool allow_empty = false ); :ref:`primitive_desc`( const :ref:`desc`& adesc, const primitive_attr& attr, const :ref:`engine`& aengine, bool allow_empty = false ); :ref:`primitive_desc`(:ref:`dnnl_primitive_desc_t` pd); // methods :ref:`memory::desc` :ref:`src_layer_desc`() const; :ref:`memory::desc` :ref:`src_iter_desc`() const; :ref:`memory::desc` :ref:`weights_layer_desc`() const; :ref:`memory::desc` :ref:`weights_iter_desc`() const; :ref:`memory::desc` :ref:`bias_desc`() const; :ref:`memory::desc` :ref:`dst_layer_desc`() const; :ref:`memory::desc` :ref:`dst_iter_desc`() const; :ref:`memory::desc` :ref:`workspace_desc`() const; }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // methods :ref:`handle`& :ref:`operator =` (const :ref:`handle`&); :ref:`handle`& :ref:`operator =` (:ref:`handle`&&); void :ref:`reset`(T t, bool weak = false); T :ref:`get`(bool allow_empty = false) const; :ref:`operator T` () const; :ref:`operator bool` () const; bool :ref:`operator ==` (const :ref:`handle`& other) const; bool :ref:`operator !=` (const :ref:`handle`& other) const; :ref:`engine` :ref:`get_engine`() const; const char* :ref:`impl_info_str`() const; :ref:`memory::dim` :ref:`query_s64`(:ref:`query` what) const; :ref:`memory::desc` :ref:`query_md`(:ref:`query` what, int idx = 0) const; :ref:`memory::desc` :ref:`src_desc`(int idx) const; :ref:`memory::desc` :ref:`dst_desc`(int idx) const; :ref:`memory::desc` :ref:`weights_desc`(int idx) const; :ref:`memory::desc` :ref:`diff_src_desc`(int idx) const; :ref:`memory::desc` :ref:`diff_dst_desc`(int idx) const; :ref:`memory::desc` :ref:`diff_weights_desc`(int idx) const; :ref:`memory::desc` :ref:`src_desc`() const; :ref:`memory::desc` :ref:`dst_desc`() const; :ref:`memory::desc` :ref:`weights_desc`() const; :ref:`memory::desc` :ref:`diff_src_desc`() const; :ref:`memory::desc` :ref:`diff_dst_desc`() const; :ref:`memory::desc` :ref:`diff_weights_desc`() const; :ref:`memory::desc` :ref:`workspace_desc`() const; :ref:`memory::desc` :ref:`scratchpad_desc`() const; :ref:`engine` :ref:`scratchpad_engine`() const; primitive_attr :ref:`get_primitive_attr`() const; :ref:`dnnl::primitive::kind` :ref:`get_kind`() const; bool :ref:`next_impl`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`memory::desc` :ref:`src_layer_desc`() const; :ref:`memory::desc` :ref:`src_iter_desc`() const; :ref:`memory::desc` :ref:`src_iter_c_desc`() const; :ref:`memory::desc` :ref:`weights_layer_desc`() const; :ref:`memory::desc` :ref:`weights_iter_desc`() const; :ref:`memory::desc` :ref:`weights_peephole_desc`() const; :ref:`memory::desc` :ref:`weights_projection_desc`() const; :ref:`memory::desc` :ref:`bias_desc`() const; :ref:`memory::desc` :ref:`dst_layer_desc`() const; :ref:`memory::desc` :ref:`dst_iter_desc`() const; :ref:`memory::desc` :ref:`dst_iter_c_desc`() const; :ref:`memory::desc` :ref:`diff_src_layer_desc`() const; :ref:`memory::desc` :ref:`diff_src_iter_desc`() const; :ref:`memory::desc` :ref:`diff_src_iter_c_desc`() const; :ref:`memory::desc` :ref:`diff_weights_layer_desc`() const; :ref:`memory::desc` :ref:`diff_weights_iter_desc`() const; :ref:`memory::desc` :ref:`diff_weights_peephole_desc`() const; :ref:`memory::desc` :ref:`diff_weights_projection_desc`() const; :ref:`memory::desc` :ref:`diff_bias_desc`() const; :ref:`memory::desc` :ref:`diff_dst_layer_desc`() const; :ref:`memory::desc` :ref:`diff_dst_iter_desc`() const; :ref:`memory::desc` :ref:`diff_dst_iter_c_desc`() const; :ref:`primitive_desc`(); :ref:`primitive_desc`(); .. _details-structdnnl_1_1lbr__gru__forward_1_1primitive__desc: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Primitive descriptor for an LBR GRU forward propagation primitive. Construction ------------ .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1ad4f6b8d67cf3232d20e880128bde2660: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc() Default constructor. Produces an empty object. .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a9425c9c3f164342331965d229a190d26: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`desc`& adesc, const :ref:`engine`& aengine, bool allow_empty = false ) Constructs a primitive descriptor for a LBR GRU forward propagation primitive. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - adesc - Descriptor for a LBR GRU forward propagation primitive. * - aengine - Engine to use. * - allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false. .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a4d39ea71673ce5b8b65de9d67cfc7312: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`desc`& adesc, const primitive_attr& attr, const :ref:`engine`& aengine, bool allow_empty = false ) Constructs a primitive descriptor for a LBR GRU forward propagation primitive. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - adesc - Descriptor for a LBR GRU forward propagation primitive. * - attr - Primitive attributes to use. * - aengine - Engine to use. * - allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false. .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a814deffde5f7370217108fd008681e42: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc(:ref:`dnnl_primitive_desc_t` pd) Constructs a primitive descriptor for a LBR GRU forward propagation primitive from a C API primitive descriptor that must have a matching kind. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pd - C API primitive descriptor for a LBR GRU forward propagation primitive. Methods ------- .. index:: pair: function; src_layer_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1abf2294dfaf93efe319f79daa08cecd0e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` src_layer_desc() const Returns source layer memory descriptor. .. rubric:: Returns: Source layer memory descriptor. .. index:: pair: function; src_iter_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a349ebaf677751c78cadf679fa03d41fb: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` src_iter_desc() const Returns source iteration memory descriptor. .. rubric:: Returns: Source iteration memory descriptor. A zero memory descriptor if the primitive does not have a source iteration parameter. .. index:: pair: function; weights_layer_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1af79ef1043a078370952f885c56cc676b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` weights_layer_desc() const Returns weights layer memory descriptor. .. rubric:: Returns: Weights layer memory descriptor. .. index:: pair: function; weights_iter_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1ae343222d3990a5012c0b0bb321c5d08b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` weights_iter_desc() const Returns weights iteration memory descriptor. .. rubric:: Returns: Weights iteration memory descriptor. .. index:: pair: function; bias_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a9e351766a4109631b40d2bb7fb62dd96: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` bias_desc() const Returns bias memory descriptor. .. rubric:: Returns: Bias memory descriptor. A zero memory descriptor if the primitive does not have a bias parameter. .. index:: pair: function; dst_layer_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a6f024209e7752122a0ca53f91392a3c3: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` dst_layer_desc() const Returns destination layer memory descriptor. .. rubric:: Returns: Destination layer memory descriptor. .. index:: pair: function; dst_iter_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a0ea3e2c113f800e3f3c865d02714f434: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` dst_iter_desc() const Returns destination iteration memory descriptor. .. rubric:: Returns: Destination iteration memory descriptor. A zero memory descriptor if the primitive does not have a destination iteration parameter. .. index:: pair: function; workspace_desc .. _doxid-structdnnl_1_1lbr__gru__forward_1_1primitive__desc_1a8104b43652481cd5c3893fde8e567a4e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` workspace_desc() const Returns the workspace memory descriptor. .. rubric:: Returns: Workspace memory descriptor. A zero memory descriptor if the primitive does not require workspace parameter.