report.m

From Spinach Documentation Wiki
Revision as of 18:51, 5 June 2026 by Kuprov (talk | contribs) (Rename Arguments section heading to Parameters)
Jump to: navigation, search

Writes a log message to the console or an ACSII file. The message includes the call stack of the function that produced it.

Syntax

    report(spin_system,report_string)

Parameters

    report_string  - a character string

Outputs

    this function prints the message to the console or to the
    destination specified in spin_system.sys.output

Notes

  1. A newline symbol at the end of the string is not necessary - it is added by the function.
  2. All output produced by this function may be silenced by setting sys.output='hush' in the Spinach input stream or by setting spin_system.sys.output='hush' at any point during the calculation.

See also

summary.m, banner.m

Version 2.3, authors: Ilya Kuprov, Luke Edwards