Struct Prog

pub struct Prog { /* private fields */ }

An abstration for container with the computational kernels we want to execute.

A program must be one of PrgType types.

In some cases (e.g. PrgType::Src), the kernels contained in a program will be compiled at runtime, we provide the option to pass along additional compiler options.

Programs must be loaded into the MCL environment usingtheProg::load function, or created and loaded simultaneously via the Mcl::load_prog() api.

Example

 use mcl_rs::{MclEnvBuilder,PrgType};

 let mcl = MclEnvBuilder::new().num_workers(10).initialize();

 mcl.create_prog("my_path",PrgType::Src)
     .with_compile_args("-D MYDEF")
     .load();

Implementations

impl Prog

pub fn load(self)

Loads the program into the current MCL environment

Example

 use mcl_rs::{MclEnvBuilder,PrgType};

 let mcl = MclEnvBuilder::new().num_workers(10).initialize();
 let prog = mcl.create_prog("my_path",PrgType::Src);
 prog.load();

 // alternatively it is common to call 'load' directly on 'create_prog'
  mcl.create_prog("my_path2",PrgType::Src).load();

pub fn with_compile_args(self, compile_args: &str) -> Self

Allows one to specifiy arguments to pass to the compiler when compiling the kernels within this program

Example

 use mcl_rs::{MclEnvBuilder,PrgType};

 let mcl = MclEnvBuilder::new().num_workers(10).initialize();
 let prog = mcl.create_prog("my_path",PrgType::Src);
 prog.with_compile_args("-D MYDEF").load();

 // alternatively it is common to create/load a prog in one line
  mcl.create_prog("my_path2",PrgType::Src)
     .with_compile_args("-D MYDEF")
     .load();