Skip to contents

Prints a concise summary of a gradient flow basin complex object, displaying key statistics about merged minima/maxima, function value ranges, and cell complex structure.

Usage

# S3 method for class 'basin_cx'
print(x, ...)

Arguments

x

An object of class "basin_cx" as created by create.basin.cx.

...

Additional arguments passed to print methods (currently unused).

Value

Invisibly returns the input object x. This function is called for its side effect of printing a summary to the console.

Details

The print method displays:

  • Number of merged minima (ascending basins)

  • Number of merged maxima (descending basins)

  • Range of original function values

  • Cell complex summary including total number of cells (if available)

For more detailed information about the basin complex, use summary().

See also

create.basin.cx for creating basin complex objects, summary.basin_cx for detailed basin complex information

Examples

basin_cx <- list(
  basins = list(
    ascending = list(
      m1 = list(vertex = 2L, value = 0.7, vertices = c(1L, 2L)),
      m2 = list(vertex = 5L, value = 1.1, vertices = c(4L, 5L))
    ),
    descending = list(
      M1 = list(vertex = 3L, value = 3.2, vertices = c(2L, 3L, 4L))
    )
  ),
  original_y = c(2.5, 0.7, 3.2, 1.8, 1.1),
  cells = list(
    asc_desc_cells = list(c1 = list(vertices = c(2L, 3L))),
    asc_asc_cells = list(),
    desc_desc_cells = list()
  )
)
class(basin_cx) <- "basin_cx"

basin_cx