Enum ThreadCount 

pub enum ThreadCount {
    Auto,
    Fixed(usize),
    Fraction(f64),
}

How many worker threads ComputeBackend::CpuMulti should use.

Mirrors the established shape in boon-lay’s and outram-mc-libs’s own compute modules so the workspace has one vocabulary for this rather than three.

Units

Dimensionless counts. Fraction is a pure ratio.

Variants

Auto

Every logical core, via std::thread::available_parallelism, falling back to 1 if the query fails. The default.

Fixed(usize)

An explicit worker count, clamped up to a minimum of 1.

Fraction(f64)

A fraction of the available logical cores, e.g. 0.5 for half. The product is rounded to nearest and clamped to at least 1. A non-finite or non-positive fraction clamps to 1 rather than panicking.

Implementations

impl ThreadCount

pub fn resolve(self) -> usize

Resolve to a concrete worker-thread count, always >= 1.

Returns

A thread count in [1, usize::MAX]. Never zero, so it is always safe to hand to a thread-pool builder.

Example

use outram_foam_basic_lib::compute::ThreadCount;

assert_eq!(ThreadCount::Fixed(0).resolve(), 1); // clamped, not a panic
assert_eq!(ThreadCount::Fixed(3).resolve(), 3);
assert!(ThreadCount::Auto.resolve() >= 1);

Trait Implementations

impl Clone for ThreadCount

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 ThreadCount

impl Debug for ThreadCount

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

Formats the value using the given formatter.

impl Default for ThreadCount

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ThreadCount

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ThreadCount