Enum DiffActivity

pub enum DiffActivity {
    None,
    Const,
    Active,
    ActiveOnly,
    Dual,
    DualOnly,
    Duplicated,
    DuplicatedOnly,
    FakeActivitySize,
}

Dual and Duplicated (and their Only variants) are getting lowered to the same Enzyme Activity. However, under forward mode we overwrite the previous shadow value, while for reverse mode we add to the previous shadow value. To not surprise users, we picked different names. Dual numbers is also a quite well known name for forward mode AD types.

Variants

None

Implicit or Explicit () return type, so a special case of Const.

Const

Don’t compute derivatives with respect to this input/output.

Active

Reverse Mode, Compute derivatives for this scalar input/output.

ActiveOnly

Reverse Mode, Compute derivatives for this scalar output, but don’t compute the original return value.

Dual

Forward Mode, Compute derivatives for this input/output and overwrite the shadow argument with it.

DualOnly

Forward Mode, Compute derivatives for this input/output and overwrite the shadow argument with it. Drop the code which updates the original input/output for maximum performance.

Duplicated

Reverse Mode, Compute derivatives for this &T or *T input and add it to the shadow argument.

DuplicatedOnly

Reverse Mode, Compute derivatives for this &T or *T input and add it to the shadow argument. Drop the code which updates the original input for maximum performance.

FakeActivitySize

All Integers must be Const, but these are used to mark the integer which represents the length of a slice/vec. This is used for safety checks on slices.

Trait Implementations

impl Clone for DiffActivity

fn clone(&self) -> DiffActivity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiffActivity

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

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for DiffActivity

fn decode(__decoder: &mut __D) -> Self

impl Display for DiffActivity

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

Formats the value using the given formatter.

impl<__E: SpanEncoder> Encodable<__E> for DiffActivity

fn encode(&self, __encoder: &mut __E)

impl FromStr for DiffActivity

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<DiffActivity, ()>

Parses a string s to return a value of this type.

impl<__CTX> HashStable<__CTX> for DiffActivity

where __CTX: HashStableContext,

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

impl PartialEq for DiffActivity

fn eq(&self, other: &DiffActivity) -> 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 Copy for DiffActivity

impl Eq for DiffActivity

impl StructuralPartialEq for DiffActivity

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte

Size for each variant:

• None: 0 bytes
• Const: 0 bytes
• Active: 0 bytes
• ActiveOnly: 0 bytes
• Dual: 0 bytes
• DualOnly: 0 bytes
• Duplicated: 0 bytes
• DuplicatedOnly: 0 bytes
• FakeActivitySize: 0 bytes