singe-cusparse 0.1.0-alpha.7

Safe Rust wrappers for the NVIDIA cuSPARSE sparse linear algebra library.
Documentation 
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

use std::{marker::PhantomData, ptr};

use singe_cuda::types::DevicePtr;

use crate::types::PointerMode;

#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub enum Scalar<'a, T> {
    Host(&'a T),
    Device(DeviceScalar<T>),
}

#[derive(Debug)]
#[non_exhaustive]
pub enum ScalarMut<'a, T> {
    Host(&'a mut T),
    Device(DeviceScalarMut<T>),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct DeviceScalar<T> {
    ptr: DevicePtr,
    _t: PhantomData<*const T>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct DeviceScalarMut<T> {
    ptr: DevicePtr,
    _t: PhantomData<*mut T>,
}

impl<'a, T> Scalar<'a, T> {
    pub const fn host(value: &'a T) -> Self {
        Self::Host(value)
    }

    /// Creates a device-resident scalar from a raw device pointer.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a valid device allocation containing a `T` for every
    /// cuSPARSE operation using this scalar.
    pub const unsafe fn device(ptr: DevicePtr) -> Self {
        Self::Device(unsafe { DeviceScalar::new(ptr) })
    }

    pub(crate) const fn pointer_mode(self) -> PointerMode {
        match self {
            Self::Host(_) => PointerMode::Host,
            Self::Device(_) => PointerMode::Device,
        }
    }

    pub(crate) const fn ptr(self) -> *const T {
        match self {
            Self::Host(value) => ptr::from_ref(value),
            Self::Device(value) => value.as_ptr(),
        }
    }
}

impl<'a, T> ScalarMut<'a, T> {
    pub const fn host(value: &'a mut T) -> Self {
        Self::Host(value)
    }

    /// Creates a mutable device-resident scalar from a raw device pointer.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a valid writable device allocation containing a `T`
    /// for every cuSPARSE operation using this scalar.
    pub const unsafe fn device(ptr: DevicePtr) -> Self {
        Self::Device(unsafe { DeviceScalarMut::new(ptr) })
    }

    pub(crate) const fn pointer_mode(&self) -> PointerMode {
        match self {
            Self::Host(_) => PointerMode::Host,
            Self::Device(_) => PointerMode::Device,
        }
    }

    pub(crate) fn as_mut_ptr(&mut self) -> *mut T {
        match self {
            Self::Host(value) => ptr::from_mut(*value),
            Self::Device(value) => value.as_mut_ptr(),
        }
    }
}

impl<'a, T> From<&'a T> for Scalar<'a, T> {
    fn from(value: &'a T) -> Self {
        Self::host(value)
    }
}

impl<T> From<DeviceScalar<T>> for Scalar<'_, T> {
    fn from(value: DeviceScalar<T>) -> Self {
        Self::Device(value)
    }
}

impl<T> DeviceScalar<T> {
    /// Creates a device scalar from a raw device pointer.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a valid device allocation containing a `T` for every
    /// cuSPARSE operation using this scalar.
    pub const unsafe fn new(ptr: DevicePtr) -> Self {
        Self {
            ptr,
            _t: PhantomData,
        }
    }

    pub const fn as_device_ptr(self) -> DevicePtr {
        self.ptr
    }

    pub const fn as_ptr(self) -> *const T {
        self.ptr.cast()
    }
}

impl<T> DeviceScalarMut<T> {
    /// Creates a mutable device scalar from a raw device pointer.
    ///
    /// # Safety
    ///
    /// `ptr` must point to a valid writable device allocation containing a `T`
    /// for every cuSPARSE operation using this scalar.
    pub const unsafe fn new(ptr: DevicePtr) -> Self {
        Self {
            ptr,
            _t: PhantomData,
        }
    }

    pub const fn as_device_ptr(&self) -> DevicePtr {
        self.ptr
    }

    pub const fn as_mut_ptr(&self) -> *mut T {
        self.ptr.cast()
    }
}

impl<'a, T> From<&'a mut T> for ScalarMut<'a, T> {
    fn from(value: &'a mut T) -> Self {
        Self::host(value)
    }
}

impl<T> From<DeviceScalarMut<T>> for ScalarMut<'_, T> {
    fn from(value: DeviceScalarMut<T>) -> Self {
        Self::Device(value)
    }
}