RustcAutodiff in rustc_hir::attrs::data_structures - Rust
Description: API documentation for the Rust `RustcAutodiff` struct in crate `rustc_hir`.

Skip to main content

## RustcAutodiff

# Struct RustcAutodiff

Source

    pub struct RustcAutodiff {
        pub mode: DiffMode,
        pub width: u32,
        pub input_activity: ThinVec<DiffActivity>,
        pub ret_activity: DiffActivity,
    }

## Fields§

§`mode: DiffMode`

Conceptually either forward or reverse mode AD, as described in various autodiff papers and e.g. in the JAX Documentation.

§`width: u32`

A user-provided, batching width. If not given, we will default to 1 (no batching). Calling a differentiated, non-batched function through a loop 100 times is equivalent to:

- Calling the function 50 times with a batch size of 2
- Calling the function 25 times with a batch size of 4, etc. A batched function takes more (or longer) arguments, and might be able to benefit from cache locality, better re-usal of primal values, and other optimizations. We will (before LLVM’s vectorizer runs) just generate most LLVM-IR instructions `width` times, so this massively increases code size. As such, values like 1024 are unlikely to work. We should consider limiting this to u8 or u16, but will leave it at u32 for experiments for now and focus on documenting the implications of a large width.

§`input_activity: ThinVec<DiffActivity>`§`ret_activity: DiffActivity`

## Implementations§

Source§

### impl RustcAutodiff

Source

#### pub fn has_primal_ret(&self) -> bool

Source§

### impl RustcAutodiff

Source

#### pub fn has_ret_activity(&self) -> bool

Source

#### pub fn has_active_only_ret(&self) -> bool

Source

#### pub fn error() -> Self

Source

#### pub fn source() -> Self

Source

#### pub fn is_active(&self) -> bool

Source

#### pub fn is_source(&self) -> bool

Source

#### pub fn apply_autodiff(&self) -> bool

Source

#### pub fn into_item( self, source: String, target: String, inputs: Vec<TypeTree>, output: TypeTree, ) -> AutoDiffItem

## Trait Implementations§

Source§

### impl Clone for RustcAutodiff

Source§

#### fn clone(&self) -> RustcAutodiff

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for RustcAutodiff

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<__D: SpanDecoder> Decodable<__D> for RustcAutodiff

Source§

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

Source§

### impl<__E: SpanEncoder> Encodable<__E> for RustcAutodiff

Source§

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

Source§

### impl PartialEq for RustcAutodiff

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · Source§

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

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

### impl PrintAttribute for RustcAutodiff

Source§

#### fn should_render(&self) -> bool

Whether or not this will render as something meaningful, or if it’s skipped (which will force the containing struct to also skip printing a comma and the field name).
Source§

#### fn print_attribute(&self, __p: &mut Printer)

Source§

### impl StableHash for RustcAutodiff

Source§

#### fn stable_hash<__Hcx: StableHashCtxt>( &self, __hcx: &mut __Hcx, __hasher: &mut StableHasher, )

Source§

### impl Eq for RustcAutodiff

Source§

### impl StructuralPartialEq for RustcAutodiff

## Auto Trait Implementations§

§

### impl DynSend for RustcAutodiff

§

### impl DynSync for RustcAutodiff

§

### impl Freeze for RustcAutodiff

§

### impl RefUnwindSafe for RustcAutodiff

§

### impl Send for RustcAutodiff

§

### impl Sync for RustcAutodiff

§

### impl Unpin for RustcAutodiff

§

### impl UnsafeUnpin for RustcAutodiff

§

### impl UnwindSafe for RustcAutodiff

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> AnyEq for T
where T: Any + PartialEq,

Source§

#### fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

#### fn as_any(&self) -> &(dyn Any + 'static)

Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

### impl<T> ErasedDestructor for T
where T: 'static,

## 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: 24 bytes