Enum PrimitiveTransposeInput 

pub enum PrimitiveTransposeInput<Op: GraphOperation> {
    Residual(ValueKey<Op>),
    Linear {
        key: ValueKey<Op>,
        primal: Option<ValueKey<Op>>,
    },
}

Input reference passed to a primitive transpose rule.

Linearized graphs contain both residual values and values that belong to the tangent flow. A transpose rule may freely use residual values as ordinary graph operands, but tangent-flow values must not be retained as tensor-valued operands in the transposed graph. When a tangent-flow value is the tangent of a known primal value, primal carries that counterpart for metadata or runtime-shape use by downstream primitive sets.

Variants

Residual(ValueKey<Op>)

Value that is independent of the differentiated tangent flow.

Linear

Value on the differentiated tangent flow.

Fields

key: ValueKey<Op>

Key of the linearized graph value.

primal: Option<ValueKey<Op>>

Primal value whose tangent this value represents, when known.

Implementations

impl<Op: GraphOperation> PrimitiveTransposeInput<Op>

pub fn key(&self) -> &ValueKey<Op>

Return the key of the linearized graph value.

pub fn primal(&self) -> Option<&ValueKey<Op>>

Return the corresponding primal key for a linear input, when known.

pub fn as_residual_value(&self) -> Option<PrimitiveValue<Op>>

Return this input as a value usable by rule builders when it is residual.

Trait Implementations

impl<Op: Clone + GraphOperation> Clone for PrimitiveTransposeInput<Op>

fn clone(&self) -> PrimitiveTransposeInput<Op>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Op: Debug + GraphOperation> Debug for PrimitiveTransposeInput<Op>

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

Formats the value using the given formatter.

impl<Op: Eq + GraphOperation> Eq for PrimitiveTransposeInput<Op>

impl<Op: Hash + GraphOperation> Hash for PrimitiveTransposeInput<Op>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Op: PartialEq + GraphOperation> PartialEq for PrimitiveTransposeInput<Op>

fn eq(&self, other: &PrimitiveTransposeInput<Op>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<Op: PartialEq + GraphOperation> StructuralPartialEq for PrimitiveTransposeInput<Op>