iterprinter 0.1.2

An iteration history printer

IterationPrinter: A simple iteration history printer

When using iterative numerical algorithms it is common to print after each iteration a message so that a user can monitor convergence and catch any bugs. As an example, demo.py implements a simple bisection algorithm for computing the square root of two. The following is the output using this library:

Usage

from iterprinter import IterationPrinter

# Initialize the printer by passing formatting information each column
printer = IterationPrinter(it = '4d', obj = '16.6e')

# Print a header for the table
printer.print_header(it = 'iter', obj = 'objective')

# Print a normal line of history
printer.print_iter(it = 0, obj = 5e3 )

# If a particular field is not provided, the column is left empty
printer.print_iter(it = 1)

For a more complete example, see demo.py.