Struct Function

pub struct Function<'a> { /* private fields */ }

Handle to a global kernel function.

Implementations

impl<'a> Function<'a>

pub fn get_attribute(&self, attr: FunctionAttribute) -> CudaResult<i32>

Returns information about a function.

Examples

use rustacuda::function::FunctionAttribute;
let function = module.get_function(&name)?;
let shared_memory = function.get_attribute(FunctionAttribute::SharedMemorySizeBytes)?;
println!("This function uses {} bytes of shared memory", shared_memory);

pub fn set_cache_config(&mut self, config: CacheConfig) -> CudaResult<()>

Sets the preferred cache configuration for this function.

On devices where L1 cache and shared memory use the same hardware resources, this sets the preferred cache configuration for this function. This is only a preference. The driver will use the requested configuration if possible, but is free to choose a different configuration if required to execute the function. This setting will override the context-wide setting.

This setting does nothing on devices where the size of the L1 cache and shared memory are fixed.

Example

use rustacuda::context::CacheConfig;
let mut function = module.get_function(&name)?;
function.set_cache_config(CacheConfig::PreferL1)?;

pub fn set_shared_memory_config( &mut self, cfg: SharedMemoryConfig, ) -> CudaResult<()>

Sets the preferred shared memory configuration for this function.

On devices with configurable shared memory banks, this function will set this function’s shared memory bank size which is used for subsequent launches of this function. If not set, the context-wide setting will be used instead.

Example

use rustacuda::context::SharedMemoryConfig;
let mut function = module.get_function(&name)?;
function.set_shared_memory_config(SharedMemoryConfig::EightByteBankSize)?;

Trait Implementations

impl<'a> Debug for Function<'a>

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

Formats the value using the given formatter.