HPC-Tools-for-Quantum-Computing/src/backends/opencl/mod.rs

use gate::Gate;
use traits::Backend;

use failure::Error;
use num_complex::{Complex, Complex32};
use ocl::{Buffer, MemFlags, ProQue};
use rand::random;
use std::fmt;

// OpenCL Kernel
pub static KERNEL: &'static str = include_str!("kernel.cl");

#[derive(Debug)]
pub struct OpenCL {
    /// OpenCL Buffer for the state vector
    pub buffer: Buffer<Complex<f32>>,
    pro_que: ProQue,
    num_qubits: u8,
}

impl OpenCL {
    /// Initialize a new OpenCL Backend
    ///
    /// Takes an argument of the number of qubits to use
    /// in the register, and returns a result with the backend.
    pub fn new(num_qubits: u8) -> Result<OpenCL, Error> {
        // How many amplitudes needed?
        let num_amps = 2_usize.pow(u32::from(num_qubits)) as usize;

        let ocl_pq = ProQue::builder()
            .src(KERNEL)
            .device(1)
            .dims(num_amps)
            .build()?;

        let buffer: Buffer<Complex32> = Buffer::builder()
            .queue(ocl_pq.queue().clone())
            .flags(MemFlags::new().read_write())
            .len(num_amps)
            .build()?;

        let apply = ocl_pq
            .kernel_builder("initialize_register")
            .arg(&buffer)
            .arg(0)
            .build()?;

        unsafe {
            apply.enq()?;
        }

        Ok(OpenCL {
            pro_que: ocl_pq,
            buffer,
            num_qubits,
        })
    }

    /// Note that this method doesn't mutate the state, thus
    /// a new vector must be created, which means you will have to have
    /// enough memory to store another object half the size of the
    /// state vector
    ///
    /// **This methods is very likely to change!**
    fn get_probabilities(&self) -> Result<Vec<f32>, Error> {
        let result_buffer: Buffer<f32> = self.pro_que.create_buffer()?;

        let apply = self
            .pro_que
            .kernel_builder("calculate_probabilities")
            .arg(&self.buffer)
            .arg(&result_buffer)
            .build()?;

        unsafe {
            apply.enq()?;
        }

        let mut vec_result = vec![0.0f32; self.buffer.len()];
        result_buffer.read(&mut vec_result).enq()?;

        Ok(vec_result)
    }
}

impl Backend for OpenCL {
    fn apply_gate(&mut self, gate: Gate, target: u8) -> Result<(), Error> {
        let apply = self
            .pro_que
            .kernel_builder("apply_gate")
            .global_work_size(&self.buffer.len() / 2)
            .arg(&self.buffer)
            .arg(i32::from(target))
            .arg(gate.a)
            .arg(gate.b)
            .arg(gate.c)
            .arg(gate.d)
            .build()?;

        unsafe {
            apply.enq()?;
        }

        Ok(())
    }

    fn apply_controlled_gate(&mut self, gate: Gate, control: u8, target: u8) -> Result<(), Error> {
        let apply = self
            .pro_que
            .kernel_builder("apply_controlled_gate")
            .global_work_size(&self.buffer.len() / 2)
            .arg(&self.buffer)
            .arg(i32::from(control))
            .arg(i32::from(target))
            .arg(gate.a)
            .arg(gate.b)
            .arg(gate.c)
            .arg(gate.d)
            .build()?;

        unsafe {
            apply.enq()?;
        }

        Ok(())
    }

    /// Measure the whole register, leaving the register in
    /// the measured state
    /// 
    /// Note: Currently this leaves the register in the unmeasured state.
    fn measure(&mut self) -> Result<u64, Error> {
        let probabilities = self.get_probabilities()?;

        // A key must be generated on the host, as most
        // external accelerators do not have in built support
        // for random number generation
        let mut key = random::<f32>();
        if key > 1.0 {
            key %= 1.0;
        }

        let mut i = 0;
        while i < probabilities.len() {
            key -= probabilities[i];
            if key <= 0.0 {
                break;
            }
            i += 1;
        }

        Ok(i as u64)
    }

    /// Measure the value of a single qubit, leaving the register in
    /// the state where only that qubit (or any entangled qubits) have
    /// been collapsed
    fn measure_qubit(&mut self, _target: u8) -> Result<u64, Error> {
        unimplemented!()
    }

    /// Get the number of qubits that this backend was initialized for
    fn num_qubits(&self) -> u8 {
        self.num_qubits
    }
}

impl fmt::Display for OpenCL {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let mut first = true;

        let mut vec_result = vec![Complex32::new(0.0, 0.0); self.buffer.len()];
        self.buffer
            .read(&mut vec_result)
            .enq()
            .expect("Error Reading Memory From Device");

        for (idx, item) in vec_result.iter().enumerate() {
            if !first {
                write!(f, ", ")?;
            } else {
                first = false;
            }

            write!(f, "[{}]: ", idx)?;

            // Do we print the imaginary part?
            if item.im == 0.0 {
                write!(f, "{}", item.re)?;
            } else if item.re == 0.0 {
                write!(f, "{}i", item.im)?;
            } else {
                write!(f, "{}", item)?;
            }
        }

        Ok(())
    }
}