Struct BlockPlan 

pub struct BlockPlan { /* private fields */ }

A division of 0..count into fixed-size blocks.

Examples

use molframe_core::parallel::BlockPlan;

let plan = BlockPlan::new(10, 4);
assert_eq!(plan.blocks(), 3);
assert_eq!(plan.range(0), Some(0..4));
assert_eq!(plan.range(2), Some(8..10));
assert_eq!(plan.range(3), None);

Implementations

impl BlockPlan

pub const fn new(count: usize, block: usize) -> Self

Divides count items into blocks of at most block items.

A zero block size is raised to one, because a plan that cannot advance is not a plan.

pub const fn with_default_block(count: usize) -> Self

Divides count items using DEFAULT_BLOCK_ITEMS.

pub const fn count(self) -> usize

The number of items covered.

pub const fn block(self) -> usize

The number of items in a full block.

pub const fn blocks(self) -> usize

The number of blocks.

pub const fn is_empty(self) -> bool

Returns true when there is nothing to divide.

pub fn range(self, index: usize) -> Option<Range<usize>>

The half-open item range block index covers.

pub fn ranges(self) -> impl Iterator<Item = Range<usize>>

Every block range, in ascending index order.

pub fn useful_workers(self, requested: usize) -> usize

How many workers can be usefully applied to this plan.

Never more than the number of blocks, because a worker with no block costs a thread and returns nothing.

Trait Implementations

impl Clone for BlockPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BlockPlan

impl Debug for BlockPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BlockPlan

impl PartialEq for BlockPlan

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BlockPlan