Struct PtxFunction 

pub struct PtxFunction {
    pub name: String,
    pub params: Vec<(String, PtxType)>,
    pub body: Vec<Instruction>,
    pub shared_mem: Vec<(String, PtxType, usize)>,
    pub max_threads: Option<u32>,
}

A PTX kernel or device function definition.

This structure holds all the information needed to emit a complete PTX function: the function signature (name and typed parameters), the instruction body, any shared memory allocations, and optional performance hints.

Examples

use oxicuda_ptx::ir::{PtxFunction, PtxType};

let func = PtxFunction {
    name: "vector_add".to_string(),
    params: vec![
        ("a_ptr".to_string(), PtxType::U64),
        ("b_ptr".to_string(), PtxType::U64),
        ("c_ptr".to_string(), PtxType::U64),
        ("n".to_string(), PtxType::U32),
    ],
    body: Vec::new(),
    shared_mem: Vec::new(),
    max_threads: Some(256),
};
assert_eq!(func.params.len(), 4);

Fields

name: String

The function name (without leading underscore — emitter adds $ prefix if needed).

params: Vec<(String, PtxType)>

Kernel parameters as (name, type) pairs.

body: Vec<Instruction>

The instruction body of the function.

shared_mem: Vec<(String, PtxType, usize)>

Static shared memory declarations as (name, element_type, num_elements).

max_threads: Option<u32>

Optional .maxnthreads directive (launch bounds hint to ptxas).

Implementations

impl PtxFunction

pub fn new(name: impl Into<String>) -> Self

Creates a new empty function with the given name.

pub fn add_param(&mut self, name: impl Into<String>, ty: PtxType)

Adds a parameter to the function signature.

pub fn add_shared_mem( &mut self, name: impl Into<String>, ty: PtxType, count: usize, )

Adds a static shared memory allocation.

pub fn push(&mut self, inst: Instruction)

Appends an instruction to the function body.

Trait Implementations

impl Clone for PtxFunction

fn clone(&self) -> PtxFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtxFunction

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

Formats the value using the given formatter.