Summary Method for Harmonic Smoother Results

Provides detailed summary statistics for harmonic smoother results, including the evolution of extrema counts and basin structure differences.

Usage

# S3 method for class 'harmonic_smoother'
summary(object, ...)

Arguments

object

An object of class "harmonic_smoother".

...

Further arguments passed to or from other methods.

Value

An object of class "summary.harmonic_smoother" containing:

stable_iteration, stability_detected

Extrema-stability detection, separate from numerical convergence; iteration is NA if undetected

converged, status, num_iterations

Numerical relaxation status

iterations_recorded

Total number of recorded iterations

initial_extrema

Number of extrema at the first iteration

initial_maxima

Number of maxima at the first iteration

initial_minima

Number of minima at the first iteration

final_extrema

Number of extrema at the final iteration

final_maxima

Number of maxima at the final iteration

final_minima

Number of minima at the final iteration

extrema_reduction

Reduction in number of extrema

topology_diff_summary

Summary statistics of topology differences

See also

harmonic.smoother, print.summary.harmonic_smoother

Examples

fit <- structure(
  list(
    stable_iteration = 2L,
    i_basins = list(matrix(c(1, 1), ncol = 2)),
    topology_differences = numeric()
  ),
  class = "harmonic_smoother"
)
summary(fit)
#> Summary of Harmonic Smoother Results
#> -----------------------------------
#> Numerical convergence: unavailable (older object) 
#> Extrema stability detection: unavailable (older object)
#> Total iterations recorded: 1
#> 
#> Extrema Evolution:
#>   Initial: 1 total (0 maxima, 1 minima)
#>   Final:   1 total (0 maxima, 1 minima)
#>   Reduction: 0 extrema (0.0%)
#>