Intel® oneAPI Deep Neural Network Developer Guide and Reference
struct dnnl::resampling_backward::primitive_desc
Overview
Primitive descriptor for resampling backward propagation primitive. More…
#include <dnnl.hpp>
struct primitive_desc: public dnnl::primitive_desc
{
    // construction
    primitive_desc();
    primitive_desc(
        const engine& aengine,
        algorithm aalgorithm,
        const memory::desc& diff_src_desc,
        const memory::desc& diff_dst_desc,
        const resampling_forward::primitive_desc& hint_fwd_pd,
        const primitive_attr& attr = default_attr(),
        bool allow_empty = false
        );
    primitive_desc(
        const engine& aengine,
        algorithm aalgorithm,
        const std::vector<float>& factors,
        const memory::desc& diff_src_desc,
        const memory::desc& diff_dst_desc,
        const resampling_forward::primitive_desc& hint_fwd_pd,
        const primitive_attr& attr = default_attr(),
        bool allow_empty = false
        );
    primitive_desc(dnnl_primitive_desc_t pd);
    // methods
    memory::desc diff_src_desc() const;
    memory::desc diff_dst_desc() const;
}; 
    
   Inherited Members
public:
    // methods
    handle<T, traits>& operator = (const handle<T, traits>&);
    handle<T, traits>& operator = (handle<T, traits>&&);
    void reset(T t, bool weak = false);
    T get(bool allow_empty = false) const;
    operator T () const;
    operator bool () const;
    bool operator == (const handle<T, traits>& other) const;
    bool operator != (const handle& other) const;
    engine get_engine() const;
    const char* impl_info_str() const;
    memory::dim query_s64(query what) const;
    memory::dims get_strides() const;
    memory::dims get_dilations() const;
    memory::dims get_padding_l() const;
    memory::dims get_padding_r() const;
    float get_epsilon() const;
    template <typename T = unsigned>
    T get_flags() const;
    dnnl::algorithm get_algorithm() const;
    float get_alpha() const;
    float get_beta() const;
    int get_axis() const;
    memory::dim get_local_size() const;
    float get_k() const;
    float get_p() const;
    std::vector<float> get_factors() const;
    dnnl::algorithm get_cell_kind() const;
    dnnl::rnn_direction get_direction() const;
    dnnl::algorithm get_activation_kind() const;
    memory::dims get_kernel() const;
    memory::dim get_group_size() const;
    dnnl::prop_kind get_prop_kind() const;
    memory::desc query_md(query what, int idx = 0) const;
    memory::desc src_desc(int idx) const;
    memory::desc dst_desc(int idx) const;
    memory::desc weights_desc(int idx) const;
    memory::desc diff_src_desc(int idx) const;
    memory::desc diff_dst_desc(int idx) const;
    memory::desc diff_weights_desc(int idx) const;
    memory::desc src_desc() const;
    memory::desc dst_desc() const;
    memory::desc weights_desc() const;
    memory::desc diff_src_desc() const;
    memory::desc diff_dst_desc() const;
    memory::desc diff_weights_desc() const;
    memory::desc workspace_desc() const;
    memory::desc scratchpad_desc() const;
    engine scratchpad_engine() const;
    primitive_attr get_primitive_attr() const;
    dnnl::primitive::kind get_kind() const;
    std::vector<uint8_t> get_cache_blob_id() const;
    bool next_impl();
    primitive_desc_base();
    primitive_desc_base();
    primitive_desc_base();
    primitive_desc_base(); 
  Detailed Documentation
Primitive descriptor for resampling backward propagation primitive.
Construction
primitive_desc() 
   Default constructor. Produces an empty object.
primitive_desc(
    const engine& aengine,
    algorithm aalgorithm,
    const memory::desc& diff_src_desc,
    const memory::desc& diff_dst_desc,
    const resampling_forward::primitive_desc& hint_fwd_pd,
    const primitive_attr& attr = default_attr(),
    bool allow_empty = false
    ) 
   Constructs a primitive descriptor for a resampling backward propagation primitive using source and destination memory descriptors.
Parameters:
aengine  |  
        Engine to use.  |  
       
aalgorithm  |  
        resampling algorithm kind: either dnnl::algorithm::resampling_nearest, or dnnl::algorithm::resampling_linear  |  
       
diff_src_desc  |  
        Diff source memory descriptor.  |  
       
diff_dst_desc  |  
        Diff destination memory descriptor.  |  
       
hint_fwd_pd  |  
        Primitive descriptor for a resampling forward propagation primitive. It is used as a hint for deciding which memory format to use.  |  
       
attr  |  
        Primitive attributes to use. Attributes are optional and default to empty attributes.  |  
       
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.  |  
       
primitive_desc(
    const engine& aengine,
    algorithm aalgorithm,
    const std::vector<float>& factors,
    const memory::desc& diff_src_desc,
    const memory::desc& diff_dst_desc,
    const resampling_forward::primitive_desc& hint_fwd_pd,
    const primitive_attr& attr = default_attr(),
    bool allow_empty = false
    ) 
   Constructs a primitive descriptor for resampling backward propagation primitive.
Parameters:
aengine  |  
        Engine to use.  |  
       
aalgorithm  |  
        resampling algorithm kind: either dnnl::algorithm::resampling_nearest, or dnnl::algorithm::resampling_linear  |  
       
factors  |  
        Vector of scaling factors for spatial dimension.  |  
       
diff_src_desc  |  
        Diff source memory descriptor.  |  
       
diff_dst_desc  |  
        Diff destination memory descriptor.  |  
       
hint_fwd_pd  |  
        Primitive descriptor for a resampling forward propagation primitive. It is used as a hint for deciding which memory format to use.  |  
       
attr  |  
        Primitive attributes to use. Attributes are optional and default to empty attributes.  |  
       
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.  |  
       
primitive_desc(dnnl_primitive_desc_t pd) 
   Constructs a primitive descriptor for a resampling backward propagation primitive from a C API primitive descriptor that must have a matching kind.
Parameters:
pd  |  
        C API primitive descriptor for a resampling backward propagation primitive.  |  
       
Methods
memory::desc diff_src_desc() const 
   Returns a diff source memory descriptor.
Returns:
Diff source memory descriptor.
A zero memory descriptor if the primitive does not have a diff source memory with.
memory::desc diff_dst_desc() const 
   Returns a diff destination memory descriptor.
Returns:
Diff destination memory descriptor.
A zero memory descriptor if the primitive does not have a diff destination parameter.