dqcsim 0.0.4

DQCsim: Delft Quantum Classical Simulator
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

//! Channel abstractions.
//!
//! Defines a [`Channel`] trait based on a [`Sender`] and [`Receiver`] trait
//! combination to abstract over different channel types.
//!
//! [`Channel`]: ./trait.Channel.html
//! [`Sender`]: ./trait.Sender.html
//! [`Receiver`]: ./trait.Receiver.html

use crate::common::protocol::{GatestreamDown, GatestreamUp, PluginToSimulator, SimulatorToPlugin};
use ipc_channel::ipc;
use serde::{Deserialize, Serialize};
use std::fmt::Debug;

/// Channel abstraction.
pub trait Channel {
    /// The message type of the sender.
    type SenderItem: Into<Self::ReceiverItem>;
    /// The message type of the receiver.
    type ReceiverItem: From<Self::SenderItem>;
    /// Sender side.
    type Sender: Sender<Item = Self::SenderItem>;
    /// Receiver side;
    type Receiver: Receiver<Item = Self::ReceiverItem>;
}

pub type CrossbeamChannel<T, U> = (crossbeam_channel::Sender<T>, crossbeam_channel::Receiver<U>);
pub type IpcChannel<T, U> = (ipc::IpcSender<T>, ipc::IpcReceiver<U>);

pub type SimulatorChannel = IpcChannel<SimulatorToPlugin, PluginToSimulator>;
pub type PluginChannel = IpcChannel<PluginToSimulator, SimulatorToPlugin>;
pub type UpstreamChannel = IpcChannel<GatestreamUp, GatestreamDown>;
pub type DownstreamChannel = IpcChannel<GatestreamDown, GatestreamUp>;

impl<T, U> Channel for CrossbeamChannel<T, U>
where
    T: Into<U>,
    U: From<T>,
{
    type SenderItem = T;
    type ReceiverItem = U;
    type Sender = crossbeam_channel::Sender<T>;
    type Receiver = crossbeam_channel::Receiver<U>;
}

impl<T, U> Channel for IpcChannel<T, U>
where
    T: Serialize + Into<U>,
    U: Serialize + for<'de> Deserialize<'de> + From<T>,
{
    type SenderItem = T;
    type ReceiverItem = U;
    type Sender = ipc::IpcSender<T>;
    type Receiver = ipc::IpcReceiver<U>;
}

/// Sender side of a channel.
pub trait Sender {
    /// The message type of the channel.
    type Item;
    /// The error type of the Result returned by the send function.
    type Error: Debug;

    /// Send a message.
    fn send(&self, item: Self::Item) -> Result<(), Self::Error>;
}

/// Receiver side of a channel.
pub trait Receiver {
    /// The message type of the channel.
    type Item;
    /// The error type of the Result returned by the recv function.
    type Error: Debug;

    /// Receive a message.
    fn recv(&self) -> Result<Self::Item, Self::Error>;
}

impl<T> Sender for crossbeam_channel::Sender<T> {
    type Item = T;
    type Error = crossbeam_channel::SendError<Self::Item>;

    fn send(&self, item: Self::Item) -> Result<(), Self::Error> {
        self.send(item)
    }
}

impl<T: Serialize> Sender for ipc::IpcSender<T> {
    type Item = T;
    type Error = ipc_channel::Error;

    fn send(&self, item: Self::Item) -> Result<(), Self::Error> {
        self.send(item)
    }
}

impl<T> Receiver for crossbeam_channel::Receiver<T> {
    type Item = T;
    type Error = crossbeam_channel::RecvError;

    fn recv(&self) -> Result<Self::Item, Self::Error> {
        self.recv()
    }
}

impl<T> Receiver for ipc::IpcReceiver<T>
where
    T: Serialize + for<'de> Deserialize<'de>,
{
    type Item = T;
    type Error = ipc_channel::Error;

    fn recv(&self) -> Result<Self::Item, Self::Error> {
        self.recv()
    }
}