Struct GradientCheckResult 

pub struct GradientCheckResult {
    pub passed: bool,
    pub max_relative_error: f64,
    pub max_absolute_error: f64,
    pub num_elements_checked: usize,
    pub num_failures: usize,
    pub failed_indices: Vec<usize>,
    pub error_message: Option<String>,
}

Result of gradient checking

Fields

passed: bool

Whether the gradient check passed

max_relative_error: f64

Maximum relative error found

max_absolute_error: f64

Maximum absolute error found

num_elements_checked: usize

Number of elements checked

num_failures: usize

Number of elements that failed tolerance check

failed_indices: Vec<usize>

Indices of failed elements (if check_elementwise is true)

error_message: Option<String>

Detailed error message if check failed

Implementations

impl GradientCheckResult

pub fn is_ok(&self) -> bool

Check if the gradient validation passed

pub fn failure_rate(&self) -> f64

Get failure rate (percentage of elements that failed)

pub fn summary(&self) -> String

Generate a summary report

Trait Implementations

impl Clone for GradientCheckResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GradientCheckResult

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

Formats the value using the given formatter.