quest-rs 0.2.8

Safe Rust wrapper around the Quantum Exact Simulation Toolkit (QuEST)
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

use crate::ffi;

/// QuEST Environment
pub struct QuestEnv {
    env: ffi::QuESTEnv,
}

impl QuestEnv {
    pub fn new() -> Self {
        unsafe {
            QuestEnv {
                env: ffi::createQuESTEnv(),
            }
        }
    }

    pub fn sync(&mut self) {
        unsafe {
            ffi::syncQuESTEnv(self.env);
        }
    }

    pub fn report(&self) {
        unsafe {
            ffi::reportQuESTEnv(self.env);
        }
    }
}

impl Default for QuestEnv {
    fn default() -> Self {
        Self::new()
    }
}

impl Drop for QuestEnv {
    fn drop(&mut self) {
        unsafe {
            ffi::destroyQuESTEnv(self.env);
        }
    }
}

impl From<QuestEnv> for ffi::QuESTEnv {
    fn from(item: QuestEnv) -> Self {
        item.env
    }
}

impl From<&QuestEnv> for ffi::QuESTEnv {
    fn from(item: &QuestEnv) -> Self {
        item.env
    }
}

pub fn seed_quest(seed_values: Vec<u64>) {
    unsafe {
        ffi::seedQuEST(seed_values.as_ptr() as *mut u64, seed_values.len() as i32);
    }
}

/// Seed the Mersenne Twister used for random number generation in the QuEST
/// environment with an example defualt seed.
///
/// This default seeding function uses the mt19937 init_by_array function with
/// two keys -- time and pid. Subsequent calls to mt19937 genrand functions will
/// use this seeding. For a multi process code, the same seed is given to all
/// process, therefore this seeding is only appropriate to use for functions such
/// as measure where all processes require the same random value.
///
/// For more information about the MT, see:
/// http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html.
pub fn seed_quest_default() {
    unsafe {
        ffi::seedQuESTDefault();
    }
}