Struct ShapeGuardContext 

pub struct ShapeGuardContext { /* private fields */ }

AD context providing dimension resolution, guard recording, and value metadata.

Examples

use tenferro_ops::ShapeGuardContext;

let ctx = ShapeGuardContext::default();
assert!(ctx.guards().is_empty());

Implementations

impl ShapeGuardContext

pub fn with_global_metadata() -> Self

Create a context backed by the global metadata registry.

Instead of cloning the entire global registry up-front (which used to be O(N) per AD pass and quadratic across oracle_replay), the context keeps a flag and lazily fetches entries from the shared lookup_global_metadata on first miss, caching into its local metadata map for subsequent reads within the same pass.

Examples

let ctx = tenferro_ops::ShapeGuardContext::with_global_metadata();
assert!(ctx.guards().is_empty());

pub fn with_linearize_active_values( self, keys: Arc<HashSet<ValueKey<StdTensorOp>>>, ) -> Self

pub fn is_value_active_in_linearize(&self, key: &ValueKey<StdTensorOp>) -> bool

Whether a primal value lies on a path from the current linearize targets.

When no active set was attached, every value is treated as active so existing callers keep the conservative full JVP graphs.

pub fn set_transpose_primal_outputs( &mut self, keys: Option<Vec<ValueKey<StdTensorOp>>>, )

Primal output keys for the operation currently being transposed.

Primary-mode extension transpose rules such as Eigh use these to reuse forward eigenvectors instead of recomputing a decomposition.

pub fn transpose_primal_outputs(&mut self) -> Option<&[ValueKey<StdTensorOp>]>

Return the current primal outputs and mark them as consumed by this rule.

pub fn transpose_primal_outputs_were_used(&self) -> bool

pub fn guards(&self) -> &[ShapeGuard]

Returns the guards recorded so far.

Examples

use tenferro_ops::ShapeGuardContext;

let ctx = ShapeGuardContext::default();
assert_eq!(ctx.guards(), &[]);

pub fn clear_guards(&mut self)

Clears all recorded guards.

Examples

use tenferro_ops::ShapeGuardContext;

let mut ctx = ShapeGuardContext::default();
ctx.clear_guards();
assert!(ctx.guards().is_empty());

pub fn shape_of( &mut self, val: &ValueRef<StdTensorOp>, ) -> ShapeGuardResult<Vec<SymDim>>

Return the shape metadata for a value reference.

Examples

use computegraph::types::{ValueKey, ValueRef};
use tenferro_ops::input_key::TensorInputKey;
use tenferro_ops::std_tensor_op::StdTensorOp;
use tenferro_ops::{ShapeGuardContext, SymDim, TensorMeta};
use tenferro_tensor::DType;

let key = ValueKey::<StdTensorOp>::Input(TensorInputKey::User { id: 1 });
let value = ValueRef::External(key.clone());
let mut ctx = ShapeGuardContext::default();
ctx.insert_metadata(key, TensorMeta::exact(DType::F64, vec![SymDim::from(4usize)]));

let shape = ctx.shape_of(&value).unwrap();
assert_eq!(shape, &[SymDim::from(4usize)]);

Errors

Returns ShapeGuardError when the value cannot be resolved, metadata is missing, or the metadata does not describe an exact shape.

pub fn rank_of( &mut self, val: &ValueRef<StdTensorOp>, ) -> ShapeGuardResult<usize>

Return the rank for a value reference without requiring exact extents.

Use this when an AD rule only needs axis count or needs to build runtime-shape references. Calling ShapeGuardContext::shape_of in those cases would reject valid values such as DynamicTruncate outputs whose runtime extent is known only as an upper bound.

Examples

use computegraph::types::{ValueKey, ValueRef};
use tenferro_ops::input_key::TensorInputKey;
use tenferro_ops::std_tensor_op::StdTensorOp;
use tenferro_ops::{ShapeExtent, ShapeGuardContext, SymDim, TensorMeta};
use tenferro_tensor::DType;

let key = ValueKey::<StdTensorOp>::Input(TensorInputKey::User { id: 1 });
let value = ValueRef::External(key.clone());
let mut ctx = ShapeGuardContext::default();
ctx.insert_metadata(
    key,
    TensorMeta::with_extents(DType::F64, vec![ShapeExtent::upper_bound(SymDim::from(8usize))]),
);

assert_eq!(ctx.rank_of(&value).unwrap(), 1);

Errors

Returns ShapeGuardError when the value cannot be resolved or its metadata is unavailable.

pub fn extents_of( &mut self, val: &ValueRef<StdTensorOp>, ) -> ShapeGuardResult<&[ShapeExtent<SymDim>]>

Return per-axis shape guarantees for a value reference.

Examples

use computegraph::types::{ValueKey, ValueRef};
use tenferro_ops::input_key::TensorInputKey;
use tenferro_ops::std_tensor_op::StdTensorOp;
use tenferro_ops::{ShapeExtent, ShapeGuardContext, SymDim, TensorMeta};
use tenferro_tensor::DType;

let key = ValueKey::<StdTensorOp>::Input(TensorInputKey::User { id: 1 });
let value = ValueRef::External(key.clone());
let mut ctx = ShapeGuardContext::default();
ctx.insert_metadata(
    key,
    TensorMeta::with_extents(DType::F64, vec![ShapeExtent::upper_bound(SymDim::from(8usize))]),
);

let extents = ctx.extents_of(&value).unwrap();
assert_eq!(extents[0], ShapeExtent::upper_bound(SymDim::from(8usize)));

Errors

Returns ShapeGuardError when the value cannot be resolved or its metadata is unavailable.

pub fn exact_shape_of( &mut self, val: &ValueRef<StdTensorOp>, ) -> ShapeGuardResult<Option<Vec<SymDim>>>

Return the exact shape for a value reference, if all axes are exact.

Examples

use computegraph::types::{ValueKey, ValueRef};
use tenferro_ops::input_key::TensorInputKey;
use tenferro_ops::std_tensor_op::StdTensorOp;
use tenferro_ops::{ShapeExtent, ShapeGuardContext, SymDim, TensorMeta};
use tenferro_tensor::DType;

let key = ValueKey::<StdTensorOp>::Input(TensorInputKey::User { id: 1 });
let value = ValueRef::External(key.clone());
let mut ctx = ShapeGuardContext::default();
ctx.insert_metadata(
    key,
    TensorMeta::with_extents(DType::F64, vec![ShapeExtent::upper_bound(SymDim::from(8usize))]),
);

let maybe_shape = ctx.exact_shape_of(&value).unwrap();
assert_eq!(maybe_shape, None);

Errors

Returns ShapeGuardError when the value cannot be resolved or its metadata is unavailable.

pub fn dtype_of( &mut self, val: &ValueRef<StdTensorOp>, ) -> ShapeGuardResult<DType>

Return the dtype metadata for a value reference.

Examples

use computegraph::types::{ValueKey, ValueRef};
use tenferro_ops::input_key::TensorInputKey;
use tenferro_ops::std_tensor_op::StdTensorOp;
use tenferro_ops::{ShapeGuardContext, SymDim, TensorMeta};
use tenferro_tensor::DType;

let key = ValueKey::<StdTensorOp>::Input(TensorInputKey::User { id: 1 });
let value = ValueRef::External(key.clone());
let mut ctx = ShapeGuardContext::default();
ctx.insert_metadata(key, TensorMeta::exact(DType::F64, vec![SymDim::from(4usize)]));

let dtype = ctx.dtype_of(&value).unwrap();
assert_eq!(dtype, DType::F64);

Errors

Returns ShapeGuardError when the value cannot be resolved or its metadata is unavailable.

pub fn metadata_of( &mut self, val: &ValueRef<StdTensorOp>, ) -> ShapeGuardResult<&TensorMeta>

Return the complete metadata record for a value reference.

Examples

use computegraph::types::{ValueKey, ValueRef};
use tenferro_ops::input_key::TensorInputKey;
use tenferro_ops::std_tensor_op::StdTensorOp;
use tenferro_ops::{ShapeGuardContext, SymDim, TensorMeta};
use tenferro_tensor::DType;

let key = ValueKey::<StdTensorOp>::Input(TensorInputKey::User { id: 1 });
let value = ValueRef::External(key.clone());
let mut ctx = ShapeGuardContext::default();
ctx.insert_metadata(key, TensorMeta::exact(DType::F64, vec![SymDim::from(4usize)]));

let meta = ctx.metadata_of(&value).unwrap();
assert_eq!(meta.dtype, DType::F64);

Errors

Returns ShapeGuardError when the value cannot be resolved or its metadata is unavailable.

Trait Implementations

impl Clone for ShapeGuardContext

fn clone(&self) -> ShapeGuardContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeGuardContext

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

Formats the value using the given formatter.

impl Default for ShapeGuardContext

fn default() -> ShapeGuardContext

Returns the “default value” for a type.