Enum TensorInputKey 

pub enum TensorInputKey {
    User {
        id: u64,
    },
    Tangent {
        of: Box<TensorInputKey>,
        pass: DiffPassId,
    },
}

Variants

User

Fields

id: u64

Tangent

Fields

of: Box<TensorInputKey>

pass: DiffPassId

Implementations

impl TensorInputKey

pub fn is_tangent(&self) -> bool

Returns true when this key names an AD tangent input.

Examples

use tenferro_ops::input_key::TensorInputKey;

let key = TensorInputKey::User { id: 0 };
assert!(!key.is_tangent());

pub fn primal_root(&self) -> &Self

Returns the user input key that owns this input’s concrete primal data.

For non-AD keys this returns self; for tangent keys it recursively follows the of chain to the original user input.

Examples

use tenferro_ops::input_key::TensorInputKey;

let key = TensorInputKey::User { id: 0 };
assert_eq!(key.primal_root(), &key);

Trait Implementations

impl ADKey for TensorInputKey

Available on crate feature autodiff only.

fn tangent_of(&self, pass: DiffPassId) -> Self

Create a tangent input key derived from this key. pass is a unique identifier for the linearize call.

impl Clone for TensorInputKey

fn clone(&self) -> TensorInputKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TensorInputKey

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

Formats the value using the given formatter.

impl Hash for TensorInputKey

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 PartialEq for TensorInputKey

fn eq(&self, other: &TensorInputKey) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TensorInputKey

impl StructuralPartialEq for TensorInputKey