format

Display format and number printing.

📝Syntax

fmt = format()
format()
format('default')
format(new_style)
format('truncateMatrices', 'on')
format('truncateMatrices', 'off')
format(fmt)

📥Input Arguments

Parameter	Description
new_style	a string or character vector
fmt	a nelson.display.DisplayFormatOptions object

📤Output Arguments

Parameter	Description
fmt	nelson.display.DisplayFormatOptions object: current display format

📄Description

format(new_style) changes the display format and number printing of the current session.

format('default') resets to the default format (short, loose, truncateMatrices on).

fmt = format() returns a nelson.display.DisplayFormatOptions object with the current NumericFormat, LineSpacing, and TruncateMatrices values.

format(fmt) restores the display format stored in a nelson.display.DisplayFormatOptions object.

Numeric formats supported:

short

long

shortE

longE

shortG

longG

shortEng

longEng

+

bank

rational

hex

Line spacing formats supported:

loose

compact

Matrix truncation formats supported:

format('truncateMatrices', 'on')

format('truncateMatrices', 'off')

💡Examples

Save and restore display format.

current_style = format()
pi
format('longE')
pi
format('compact')
pi
format(current_style)
pi

🕔Version History

Version	Description
1.0.0	initial version
2.0.0	format returns and accepts nelson.display.DisplayFormatOptions classdef objects.

Edit this page on GitHub