Struct cuba::CubaIntegrator

pub struct CubaIntegrator<T> { /* fields omitted */ }

A Cuba integrator. It should be created with an integrand function.

Methods

impl<T> CubaIntegrator<T>

pub fn new(integrand: Integrand<T>) -> CubaIntegrator<T>

Create a new Cuba integrator. Use the set_ functions to set integration parameters.

pub fn set_cores(
    &mut self,
    cores: usize,
    max_points_per_core: usize
) -> &mut Self

Set the number of cores and the maximum number of points per core. The default is the number of idle cores for cores and 1000 for max_points_per_core.

pub fn set_mineval(&mut self, mineval: i64) -> &mut Self

pub fn set_maxeval(&mut self, maxeval: i64) -> &mut Self

pub fn set_nstart(&mut self, nstart: i64) -> &mut Self

pub fn set_nincrease(&mut self, nincrease: i64) -> &mut Self

pub fn set_epsrel(&mut self, epsrel: f64) -> &mut Self

pub fn set_epsabs(&mut self, epsabs: f64) -> &mut Self

pub fn set_batch(&mut self, batch: i64) -> &mut Self

pub fn set_seed(&mut self, seed: i32) -> &mut Self

pub fn set_use_only_last_sample(
    &mut self,
    use_only_last_sample: bool
) -> &mut Self

pub fn set_save_state_file(&mut self, save_state_file: String) -> &mut Self

pub fn set_keep_state_file(&mut self, keep_state_file: bool) -> &mut Self

pub fn set_reset_vegas_integrator(
    &mut self,
    reset_vegas_integrator: bool
) -> &mut Self

pub fn set_key(&mut self, key: i32) -> &mut Self

pub fn set_key1(&mut self, key1: i32) -> &mut Self

pub fn set_key2(&mut self, key2: i32) -> &mut Self

pub fn set_key3(&mut self, key3: i32) -> &mut Self

pub fn set_maxpass(&mut self, maxpass: i32) -> &mut Self

pub fn set_border(&mut self, border: f64) -> &mut Self

pub fn set_maxchisq(&mut self, maxchisq: f64) -> &mut Self

pub fn set_mindeviation(&mut self, mindeviation: f64) -> &mut Self

pub fn vegas(
    &mut self,
    ndim: usize,
    ncomp: usize,
    nvec: usize,
    verbosity: CubaVerbosity,
    gridno: i32,
    user_data: T
) -> CubaResult

Integrate using the Vegas integrator.

• ndim - Dimension of the input
• ncomp - Dimension (components) of the output
• nvec - Number of input points given to the integrand function
• verbosity - Verbosity level
• gridno - Grid number between -10 and 10. If 0, no grid is stored. If it is positive, the grid is storedin the gridnoth slot. With a negative number the grid is cleared.
• user_data - User data used by the integrand function

pub fn suave(
    &mut self,
    ndim: usize,
    ncomp: usize,
    nvec: usize,
    nnew: usize,
    nmin: usize,
    flatness: f64,
    verbosity: CubaVerbosity,
    user_data: T
) -> CubaResult

Integrate using the Suave integrator.

• ndim - Dimension of the input
• ncomp - Dimension (components) of the output
• nvec - Number of input points given to the integrand function
• nnew - Number of new integrand evaluations in each subdivision
• nmin - Minimum number of samples a former pass must contribute to a subregion to be considered in that region’s compound integral value
• flatness - This determines how prominently individual samples with a large fluctuation figure in the total fluctuation
• verbosity - Verbosity level
• user_data - User data used by the integrand function

pub fn divonne(
    &mut self,
    ndim: usize,
    ncomp: usize,
    nvec: usize,
    xgiven: &[f64],
    verbosity: CubaVerbosity,
    user_data: T
) -> CubaResult

Integrate using the Divonne integrator.

• ndim - Dimension of the input
• ncomp - Dimension (components) of the output
• nvec - Number of input points given to the integrand function
• xgiven - A list of input points which lie close to peaks
• verbosity - Verbosity level
• user_data - User data used by the integrand function

pub fn cuhre(
    &mut self,
    ndim: usize,
    ncomp: usize,
    nvec: usize,
    verbosity: CubaVerbosity,
    user_data: T
) -> CubaResult

Integrate using the Cuhre integrator.

• ndim - Dimension of the input
• ncomp - Dimension (components) of the output
• nvec - Number of input points given to the integrand function
• verbosity - Verbosity level
• user_data - User data used by the integrand function