rssn 0.2.9

A comprehensive scientific computing library for Rust, aiming for feature parity with NumPy and SymPy.
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207

//! Handle-based FFI API for solid-state physics functions.

use crate::symbolic::core::Expr;
use crate::symbolic::solid_state_physics::CrystalLattice;
use crate::symbolic::solid_state_physics::density_of_states_3d;
use crate::symbolic::solid_state_physics::drude_conductivity;
use crate::symbolic::solid_state_physics::fermi_energy_3d;
use crate::symbolic::solid_state_physics::hall_coefficient;
use crate::symbolic::vector::Vector;

/// Creates a new `CrystalLattice`.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_crystal_lattice_new(
    a1: *const Vector,
    a2: *const Vector,
    a3: *const Vector,
) -> *mut CrystalLattice {
    unsafe {
        if a1.is_null() || a2.is_null() || a3.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(CrystalLattice::new(
            (*a1).clone(),
            (*a2).clone(),
            (*a3).clone(),
        )))
    }
}

/// Frees a `CrystalLattice`.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_crystal_lattice_free(ptr: *mut CrystalLattice) {
    unsafe {
        if !ptr.is_null() {
            let _ = Box::from_raw(ptr);
        }
    }
}

/// Computes the volume of the unit cell.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_crystal_lattice_volume(ptr: *const CrystalLattice) -> *mut Expr {
    unsafe {
        if ptr.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new((*ptr).volume()))
    }
}

/// Computes reciprocal lattice vectors.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_crystal_lattice_reciprocal_vectors(
    ptr: *const CrystalLattice,
    b1: *mut *mut Vector,
    b2: *mut *mut Vector,
    b3: *mut *mut Vector,
) {
    unsafe {
        if ptr.is_null() || b1.is_null() || b2.is_null() || b3.is_null() {
            return;
        }

        let (v1, v2, v3) = (*ptr).reciprocal_lattice_vectors();

        *b1 = Box::into_raw(Box::new(v1));

        *b2 = Box::into_raw(Box::new(v2));

        *b3 = Box::into_raw(Box::new(v3));
    }
}

/// Computes the density of states for a 3D electron gas.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_density_of_states_3d(
    energy: *const Expr,
    effective_mass: *const Expr,
    volume: *const Expr,
) -> *mut Expr {
    unsafe {
        if energy.is_null() || effective_mass.is_null() || volume.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(density_of_states_3d(
            &*energy,
            &*effective_mass,
            &*volume,
        )))
    }
}

/// Computes Fermi energy for a 3D electron gas.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_fermi_energy_3d(
    concentration: *const Expr,
    effective_mass: *const Expr,
) -> *mut Expr {
    unsafe {
        if concentration.is_null() || effective_mass.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(fermi_energy_3d(&*concentration, &*effective_mass)))
    }
}

/// Computes Drude conductivity.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_drude_conductivity(
    n: *const Expr,
    e_charge: *const Expr,
    tau: *const Expr,
    m_star: *const Expr,
) -> *mut Expr {
    unsafe {
        if n.is_null() || e_charge.is_null() || tau.is_null() || m_star.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(drude_conductivity(
            &*n, &*e_charge, &*tau, &*m_star,
        )))
    }
}

/// Computes Hall coefficient.
///
/// # Safety
///
/// This function is unsafe because it dereferences raw pointers as part of the FFI boundary.
/// The caller must ensure:
/// 1. All pointer arguments are valid and point to initialized memory.
/// 2. The memory layout of passed structures matches the expected C-ABI layout.
/// 3. Any pointers returned by this function are managed according to the API's ownership rules.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn rssn_hall_coefficient(
    n: *const Expr,
    q: *const Expr,
) -> *mut Expr {
    unsafe {
        if n.is_null() || q.is_null() {
            return std::ptr::null_mut();
        }

        Box::into_raw(Box::new(hall_coefficient(&*n, &*q)))
    }
}