Oakfield API Documentation 1.0.0
Numerical core APIs
Loading...
Searching...
No Matches
SimSpecialEvalReport Struct Reference

Structured report describing why a special-function helper failed. More...

#include <special_functions.h>

Collaboration diagram for SimSpecialEvalReport:

Public Attributes

SimSpecialFault fault
 
const char * function
 
SimComplexDouble input
 
double q_param
 
double aux_param
 
double exponent_param
 
int iteration_count
 
double residual
 
double tolerance
 

Detailed Description

Structured report describing why a special-function helper failed.

Member Data Documentation

◆ aux_param

double SimSpecialEvalReport::aux_param

Auxiliary real parameter (e.g., shift a).

◆ exponent_param

double SimSpecialEvalReport::exponent_param

Exponent parameter (e.g., s for ΞΆ_q).

◆ fault

SimSpecialFault SimSpecialEvalReport::fault

Fault classification.

◆ function

const char* SimSpecialEvalReport::function

Name of the helper reporting the fault.

◆ input

SimComplexDouble SimSpecialEvalReport::input

Primary input argument (real stored in .re).

◆ iteration_count

int SimSpecialEvalReport::iteration_count

Iterations consumed before exit.

◆ q_param

double SimSpecialEvalReport::q_param

q parameter when applicable (else NAN).

◆ residual

double SimSpecialEvalReport::residual

Magnitude of last term or residual.

◆ tolerance

double SimSpecialEvalReport::tolerance

Target tolerance used for the evaluation.


The documentation for this struct was generated from the following file: