1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Defines a Filter Descriptor.
//!
//! A Filter Descriptor is used to hold information about the Filter,
//! which is needed for forward and backward convolutional operations.

use super::utils::DataType;
use super::{Error, API};
use crate::ffi::*;

#[derive(Debug, Clone)]
/// Describes a Filter Descriptor.
pub struct FilterDescriptor {
    id: cudnnFilterDescriptor_t,
}

impl Drop for FilterDescriptor {
    #[allow(unused_must_use)]
    fn drop(&mut self) {
        API::destroy_filter_descriptor(*self.id_c());
    }
}

impl FilterDescriptor {
    /// Initializes a new CUDA cuDNN FilterDescriptor.
    pub fn new(filter_dim: &[i32], data_type: DataType) -> Result<FilterDescriptor, Error> {
        let nb_dims = filter_dim.len() as i32;
        let tensor_format = cudnnTensorFormat_t::CUDNN_TENSOR_NCHW;
        let data_type = API::cudnn_data_type(data_type);
        let generic_filter_desc = API::create_filter_descriptor()?;
        API::set_filter_descriptor(
            generic_filter_desc,
            data_type,
            tensor_format,
            nb_dims,
            filter_dim.as_ptr(),
        )?;
        Ok(FilterDescriptor::from_c(generic_filter_desc))
    }

    /// Initializes a new CUDA cuDNN FilterDescriptor from its C type.
    pub fn from_c(id: cudnnFilterDescriptor_t) -> FilterDescriptor {
        FilterDescriptor { id }
    }

    /// Returns the CUDA cuDNN FilterDescriptor as its C type.
    pub fn id_c(&self) -> &cudnnFilterDescriptor_t {
        &self.id
    }
}