Skip to main content

ThreadPool

Struct ThreadPool 

Source
pub struct ThreadPool { /* private fields */ }
Available on crate feature parallel only.
Expand description

A bounded Rayon pool that PRISM-Q runs inside, leaving the process-wide pool untouched.

Simulation entry points size the global Rayon pool on first use, which an embedding application may not want. Work run through ThreadPool::install uses this pool instead, and the global pool is neither built nor resized, so an application that installed its own keeps it.

Pool width is part of what a result depends on. Dense unitary evolution, seeded terminal sampling, and the stabilizer tableau are bitwise at any width, parallel reductions move by about 1e-12, and compiled (BTS) shot payloads differ between widths because the batched sampler splits shots by pool width. A narrower pool is therefore not a slower route to the same bytes for every result; the per-path contract is the determinism section of the threading architecture page.

§Examples

use prism_q::{ThreadPool, run_qasm};

let qasm = r#"
    OPENQASM 3.0;
    include "stdgates.inc";
    qubit[2] q;
    h q[0];
    cx q[0], q[1];
"#;

let pool = ThreadPool::with_threads(2).expect("build pool");
let result = pool.install(|| run_qasm(qasm, 42)).expect("simulation");
let probs = result.probabilities.expect("no probabilities").to_vec();
assert!((probs[0] - 0.5).abs() < 1e-10);

Implementations§

Source§

impl ThreadPool

Source

pub fn with_threads(threads: usize) -> Result<Self>

Build a pool of threads workers, or of the Rayon default width when threads is 0.

§Errors

Returns PrismError::InvalidParameter when the operating system refuses to spawn the workers.

Source

pub fn install<T: Send>(&self, op: impl FnOnce() -> T + Send) -> T

Run op on this pool, blocking the calling thread until it returns.

Every Rayon kernel PRISM-Q reaches from op runs on these workers. Work that escapes op, such as a simulation handed to another thread, falls back to the global pool.

Source

pub fn num_threads(&self) -> usize

Worker count, which is what rayon::current_num_threads reports inside install. Resolves the default width taken by with_threads(0).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V