ibdgen 0.1.2

Generate incomplete block designs for experiments with prohibited pairs
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

mod ibd;
mod random_type;


pub mod coincidence_matrix;
pub mod block_array;
pub mod block_result;

use ibd::*;

use block_result::BlockResult;

use anyhow::Error;


/// Finds the best incomplete block design (IBD) by running multiple iterations of the IBD generation algorithm.
///
/// # Arguments
///
/// * `v` - Number of treatments
/// * `n_b` - Number of blocks
/// * `block_size` - Number of treatments per block
/// * `n_repeats` - Number of optimization repeats within each iteration
/// * `iter` - Number of iterations to run
/// * `prohibited_pairs` - Vector of tuples containing pairs of treatments that cannot appear together in any block (0-based indices)
/// * `on_update` - Callback function called after each iteration with the current iteration number and best D-optimality value
///
/// # Returns
///
/// Returns a tuple containing:
/// * The best block design solution found (`BlockResult`)
/// * The iteration number where the best solution was found
/// * The D-optimality value of the best solution
///
/// # Errors
///
/// Returns an error if the IBD generation fails
pub fn find_best_ibd<F>(v: u8, n_b: usize, block_size: usize, n_repeats: usize, iter: usize, prohibited_pairs: Vec<(usize, usize)>, mut on_update: F) -> Result<(BlockResult, usize, f64), Error>
    where
        F: FnMut(usize, f64),
 {
    let mut best_d = 0.0;
    let mut best_solution = BlockResult::default();
    let mut best_iter = 0;
    for i in 1..=iter {
        let result = ibdgen(
            v, 
            n_b, 
            block_size, 
            n_repeats, 
            prohibited_pairs.clone()
        ).unwrap();
        
        if result.best_d > best_d {
            best_d = result.best_d;
            best_solution = result;
            best_iter = i;
        }

        on_update(i, best_d);
    }
    Ok((best_solution, best_iter, best_d))
}