Enum AdAdmissionError 

#[non_exhaustive]
pub enum AdAdmissionError {
    UnsupportedAdOrder {
        order: u32,
    },
    NonFieldScalar,
    AdRuleUnavailable,
}

Why a scalar may not be differentiated at the requested order.

This is the query result of ad_admission; it never represents a gradient.

Examples

use tenferro_tensor_core::{ad_admission, AdAdmissionError};

assert_eq!(
    ad_admission::<f64>(2),
    Err(AdAdmissionError::UnsupportedAdOrder { order: 2 })
);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnsupportedAdOrder

Only first-order differentiation is admitted for a non-preset scalar.

Fields

order: u32

Requested derivative order.

NonFieldScalar

The scalar’s arithmetic is not a field, so the canonical field derivative rules do not apply.

AdRuleUnavailable

The scalar is admissible in principle, but no derivative rules exist for it in this build.

Trait Implementations

impl Clone for AdAdmissionError

fn clone(&self) -> AdAdmissionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdAdmissionError

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

Formats the value using the given formatter.

impl Display for AdAdmissionError

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

Formats the value using the given formatter.

impl Eq for AdAdmissionError

impl Error for AdAdmissionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for AdAdmissionError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AdAdmissionError