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
50
51
52
53
54
55
56
57
58
59

//! Defines a Dropout Descriptor.
//!
//! A Tensor Descriptor is used to hold information about the probability
//! of dropping a value as well as an initial seed.

use super::{Error, API};
use crate::cudnn::Cudnn;
use crate::ffi::*;

#[derive(Debug, Clone)]
/// Describes a DropoutDescriptor.
pub struct DropoutDescriptor {
    id: cudnnDropoutDescriptor_t,
}

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

impl DropoutDescriptor {
    /// Initializes a new CUDA cuDNN Dropout Descriptor.
    pub fn new(
        handle: &Cudnn,
        dropout: f32,
        seed: u64,
        reserve: *mut libc::c_void,
        reserve_size: usize,
    ) -> Result<DropoutDescriptor, Error> {
        let generic_dropout_desc = API::create_dropout_descriptor()?;
        API::set_dropout_descriptor(
            generic_dropout_desc,
            *handle.id_c(),
            dropout,
            reserve,
            reserve_size,
            seed,
        )?;

        Ok(DropoutDescriptor::from_c(generic_dropout_desc))
    }

    /// Get the size for a tensor
    pub fn get_required_size() -> usize {
        unimplemented!()
    }

    /// Initializes a new CUDA cuDNN Tensor Descriptor from its C type.
    pub fn from_c(id: cudnnDropoutDescriptor_t) -> DropoutDescriptor {
        DropoutDescriptor { id }
    }

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