Struct ExecutionProfile 

#[non_exhaustive]
pub struct ExecutionProfile {
    pub accelerator: Accelerator,
    pub ranks: usize,
    pub threads_per_rank: usize,
}

Language-neutral execution request.

ranks > 1 denotes a distributed run. Each rank may in turn use the requested accelerator and number of host threads.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

accelerator: Accelerator

Compute device requested for each rank.

ranks: usize

Number of cooperating process ranks.

threads_per_rank: usize

Host threads available to each rank.

Implementations

impl ExecutionProfile

pub const fn serial() -> Self

Request one CPU rank and one host thread.

pub const fn throughput(threads: usize) -> Self

Request bounded host parallelism for independent work items.

pub const fn local_cpu(threads: usize) -> Self

Request one CPU rank with threads host workers.

pub const fn distributed_cpu(ranks: usize, threads_per_rank: usize) -> Self

Request a distributed CPU run.

The built-in runtime rejects this profile until an MPI implementation of Runtime is installed.

pub const fn local_gpu(device: usize, threads: usize) -> Self

Request one GPU device with the supplied host-thread allowance.

pub fn validate(self) -> Result<Self>

Validate that rank and thread counts are positive.

Trait Implementations

impl Clone for ExecutionProfile

fn clone(&self) -> ExecutionProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionProfile

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

Formats the value using the given formatter.

impl PartialEq for ExecutionProfile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ExecutionProfile

impl Eq for ExecutionProfile

impl StructuralPartialEq for ExecutionProfile