laddu-extensions 0.19.2

Extensions to the laddu library
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

//! Optimization helpers and algorithm integrations for likelihood terms.

/// Callback and observer integration used by optimization algorithms.
pub mod callbacks;
/// Bindings and adapters for optimization algorithms from `ganesh`.
pub mod ganesh;

pub use callbacks::LikelihoodTermObserver;
use laddu_core::{LadduResult, ThreadPoolManager};

/// A wrapper for the requested thread-count policy used by optimization callbacks.
#[derive(Clone, Copy, Debug)]
pub struct MaybeThreadPool {
    requested_threads: Option<usize>,
}

impl MaybeThreadPool {
    /// Crate a new thread pool with the given number of threads. This is typically used as
    /// user-data for [`ganesh`] optimizations.
    pub fn new(num_threads: usize) -> Self {
        Self {
            requested_threads: Some(num_threads),
        }
    }

    /// Run the given operation on the current thread pool.
    pub fn install<R: Send>(&self, op: impl FnOnce() -> LadduResult<R> + Send) -> LadduResult<R> {
        ThreadPoolManager::shared().install(self.requested_threads, op)?
    }
}