Struct SemanticPrimalVjpRequest 

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

Ordered inputs for one direct semantic primal-VJP rule.

Implementations

impl<'a> SemanticPrimalVjpRequest<'a>

pub fn op(&self) -> &dyn ExtensionOp

Borrow the extension payload.

Examples

let _ = request.op().family_id();

pub fn primal_input_value( &self, index: usize, ) -> Result<ProgramValue, SemanticAdError>

Return one declared primal input tensor value.

Errors

Returns SemanticAdError::PrimalIndexOutOfBounds before checking the residual mask, or SemanticAdError::UndeclaredResidualValue when the rule did not declare this input as a tensor residual.

Examples

let _ = request.primal_input_value(0)?;

pub fn primal_output_value( &self, index: usize, ) -> Result<ProgramValue, SemanticAdError>

Return one declared primal output tensor value.

Errors

Returns SemanticAdError::PrimalIndexOutOfBounds before checking the residual mask, or SemanticAdError::UndeclaredResidualValue when the rule did not declare this output as a tensor residual.

Examples

let _ = request.primal_output_value(0)?;

pub fn primal_input_meta( &self, index: usize, ) -> Result<&ProgramValueMetadata, SemanticAdError>

Borrow metadata for one primal input without exposing its value token.

Errors

Returns SemanticAdError::PrimalIndexOutOfBounds when index is not an ordered primal input.

Examples

let _ = request.primal_input_meta(0)?;

pub fn primal_output_meta( &self, index: usize, ) -> Result<&ProgramValueMetadata, SemanticAdError>

Borrow metadata for one primal output without exposing its value token.

Errors

Returns SemanticAdError::PrimalIndexOutOfBounds when index is not an ordered primal output.

Examples

let _ = request.primal_output_meta(0)?;

pub const fn primal_input_count(&self) -> usize

Return the number of ordered primal inputs.

Examples

let _ = request.primal_input_count();

pub const fn primal_output_count(&self) -> usize

Return the number of ordered primal outputs.

Examples

let _ = request.primal_output_count();

pub fn cotangent_outputs(&self) -> &[AdValue]

Borrow ordered optional output cotangents.

Examples

let _ = request.cotangent_outputs();

pub fn active_inputs(&self) -> &[bool]

Borrow the ordered active-input mask.

Examples

let _ = request.active_inputs();

pub const fn residual_mask(&self) -> ResidualSpec

Return this rule’s declared residual mask: which primal input/output indices may be read as tensor values. Accesses outside the mask must only use shape/dtype metadata.

Examples

let _ = request.residual_mask();

pub const fn provenance(&self) -> SemanticProvenanceView<'a>

Return bounded operation provenance.

Examples

let _ = request.provenance();