Tables¶
Display a rectangular array as a table, either in plain text, LaTeX,
or html. See the documentation for table for details and
examples.
AUTHORS:
John H. Palmieri (2012-11)
- class sage.misc.table.table(rows=None, columns=None, header_row=False, header_column=False, frame=False, align='left')¶
Bases:
sage.structure.sage_object.SageObjectDisplay a rectangular array as a table, either in plain text, LaTeX, or html.
INPUT:
rows(defaultNone) - a list of lists (or list of tuples, etc.), containing the data to be displayed.columns(defaultNone) - a list of lists (etc.), containing the data to be displayed, but stored as columns. Set eitherrowsorcolumns, but not both.header_row(defaultFalse) - ifTrue, first row is highlighted.header_column(defaultFalse) - ifTrue, first column is highlighted.frame(defaultFalse) - ifTrue, put a box around each cell.align(default ‘left’) - the alignment of each entry: either ‘left’, ‘center’, or ‘right’
EXAMPLES:
sage: rows = [['a', 'b', 'c'], [100,2,3], [4,5,60]] sage: table(rows) a b c 100 2 3 4 5 60 sage: latex(table(rows)) \begin{tabular}{lll} a & b & c \\ $100$ & $2$ & $3$ \\ $4$ & $5$ & $60$ \\ \end{tabular}
If
header_rowisTrue, then the first row is highlighted. Ifheader_columnisTrue, then the first column is highlighted. IfframeisTrue, then print a box around every “cell”.sage: table(rows, header_row=True) a b c +-----+---+----+ 100 2 3 4 5 60 sage: latex(table(rows, header_row=True)) \begin{tabular}{lll} a & b & c \\ \hline $100$ & $2$ & $3$ \\ $4$ & $5$ & $60$ \\ \end{tabular} sage: table(rows=rows, frame=True) +-----+---+----+ | a | b | c | +-----+---+----+ | 100 | 2 | 3 | +-----+---+----+ | 4 | 5 | 60 | +-----+---+----+ sage: latex(table(rows=rows, frame=True)) \begin{tabular}{|l|l|l|} \hline a & b & c \\ \hline $100$ & $2$ & $3$ \\ \hline $4$ & $5$ & $60$ \\ \hline \end{tabular} sage: table(rows, header_column=True, frame=True) +-----++---+----+ | a || b | c | +-----++---+----+ | 100 || 2 | 3 | +-----++---+----+ | 4 || 5 | 60 | +-----++---+----+ sage: latex(table(rows, header_row=True, frame=True)) \begin{tabular}{|l|l|l|} \hline a & b & c \\ \hline \hline $100$ & $2$ & $3$ \\ \hline $4$ & $5$ & $60$ \\ \hline \end{tabular} sage: table(rows, header_column=True) a | b c 100 | 2 3 4 | 5 60
The argument
header_rowcan, instead of beingTrueorFalse, be the contents of the header row, so thatrowsconsists of the data, whileheader_rowis the header information. The same goes forheader_column. Passing lists for both arguments simultaneously is not supported.sage: table([(x,n(sin(x), digits=2)) for x in [0..3]], header_row=["$x$", r"$\sin(x)$"], frame=True) +-----+-----------+ | $x$ | $\sin(x)$ | +=====+===========+ | 0 | 0.00 | +-----+-----------+ | 1 | 0.84 | +-----+-----------+ | 2 | 0.91 | +-----+-----------+ | 3 | 0.14 | +-----+-----------+
You can create the transpose of this table in several ways, for example, “by hand,” that is, changing the data defining the table:
sage: table(rows=[[x for x in [0..3]], [n(sin(x), digits=2) for x in [0..3]]], header_column=['$x$', r'$\sin(x)$'], frame=True) +-----------++------+------+------+------+ | $x$ || 0 | 1 | 2 | 3 | +-----------++------+------+------+------+ | $\sin(x)$ || 0.00 | 0.84 | 0.91 | 0.14 | +-----------++------+------+------+------+
or by passing the original data as the
columnsof the table and usingheader_columninstead ofheader_row:sage: table(columns=[(x,n(sin(x), digits=2)) for x in [0..3]], header_column=['$x$', r'$\sin(x)$'], frame=True) +-----------++------+------+------+------+ | $x$ || 0 | 1 | 2 | 3 | +-----------++------+------+------+------+ | $\sin(x)$ || 0.00 | 0.84 | 0.91 | 0.14 | +-----------++------+------+------+------+
or by taking the
transpose()of the original table:sage: table(rows=[(x,n(sin(x), digits=2)) for x in [0..3]], header_row=['$x$', r'$\sin(x)$'], frame=True).transpose() +-----------++------+------+------+------+ | $x$ || 0 | 1 | 2 | 3 | +-----------++------+------+------+------+ | $\sin(x)$ || 0.00 | 0.84 | 0.91 | 0.14 | +-----------++------+------+------+------+
In either plain text or LaTeX, entries in tables can be aligned to the left (default), center, or right:
sage: table(rows, align='left') a b c 100 2 3 4 5 60 sage: table(rows, align='center') a b c 100 2 3 4 5 60 sage: table(rows, align='right', frame=True) +-----+---+----+ | a | b | c | +-----+---+----+ | 100 | 2 | 3 | +-----+---+----+ | 4 | 5 | 60 | +-----+---+----+
To generate HTML you should use
html(table(...)):sage: data = [["$x$", r"$\sin(x)$"]] + [(x,n(sin(x), digits=2)) for x in [0..3]] sage: output = html(table(data, header_row=True, frame=True)) sage: type(output) <class 'sage.misc.html.HtmlFragment'> sage: print(output) <div class="notruncate"> <table border="1" class="table_form"> <tbody> <tr> <th style="text-align:left">\(x\)</th> <th style="text-align:left">\(\sin(x)\)</th> </tr> <tr class ="row-a"> <td style="text-align:left">\(0\)</td> <td style="text-align:left">\(0.00\)</td> </tr> <tr class ="row-b"> <td style="text-align:left">\(1\)</td> <td style="text-align:left">\(0.84\)</td> </tr> <tr class ="row-a"> <td style="text-align:left">\(2\)</td> <td style="text-align:left">\(0.91\)</td> </tr> <tr class ="row-b"> <td style="text-align:left">\(3\)</td> <td style="text-align:left">\(0.14\)</td> </tr> </tbody> </table> </div>
It is an error to specify both
rowsandcolumns:sage: table(rows=[[1,2,3], [4,5,6]], columns=[[0,0,0], [0,0,1024]]) Traceback (most recent call last): ... ValueError: Don't set both 'rows' and 'columns' when defining a table. sage: table(columns=[[0,0,0], [0,0,1024]]) 0 0 0 0 0 1024
Note that if
rowsis just a list or tuple, not nested, then it is treated as a single row:sage: table([1,2,3]) 1 2 3
Also, if you pass a non-rectangular array, the longer rows or columns get truncated:
sage: table([[1,2,3,7,12], [4,5]]) 1 2 4 5 sage: table(columns=[[1,2,3], [4,5,6,7]]) 1 4 2 5 3 6
- _rich_repr_(display_manager, **kwds)¶
Rich Output Magic Method
See
sage.repl.rich_outputfor details.EXAMPLES:
sage: from sage.repl.rich_output import get_display_manager sage: dm = get_display_manager() sage: t = table([1, 2, 3]) sage: t._rich_repr_(dm) # the doctest backend does not support html
- options(**kwds)¶
With no arguments, return the dictionary of options for this table. With arguments, modify options.
INPUT:
header_row- if True, first row is highlighted.header_column- if True, first column is highlighted.frame- if True, put a box around each cell.align- the alignment of each entry: either ‘left’, ‘center’, or ‘right’
EXAMPLES:
sage: T = table([['a', 'b', 'c'], [1,2,3]]) sage: T.options()['align'], T.options()['frame'] ('left', False) sage: T.options(align='right', frame=True) sage: T.options()['align'], T.options()['frame'] ('right', True)
Note that when first initializing a table,
header_roworheader_columncan be a list. In this case, during the initialization process, the header is merged with the rest of the data, so changing the header option later usingtable.options(...)doesn’t affect the contents of the table, just whether the row or column is highlighted. When using thisoptions()method, no merging of data occurs, so hereheader_rowandheader_columnshould just beTrueorFalse, not a list.sage: T = table([[1,2,3], [4,5,6]], header_row=['a', 'b', 'c'], frame=True) sage: T +---+---+---+ | a | b | c | +===+===+===+ | 1 | 2 | 3 | +---+---+---+ | 4 | 5 | 6 | +---+---+---+ sage: T.options(header_row=False) sage: T +---+---+---+ | a | b | c | +---+---+---+ | 1 | 2 | 3 | +---+---+---+ | 4 | 5 | 6 | +---+---+---+
If you do specify a list for
header_row, an error is raised:sage: T.options(header_row=['x', 'y', 'z']) Traceback (most recent call last): ... TypeError: header_row should be either True or False.
- transpose()¶
Return a table which is the transpose of this one: rows and columns have been interchanged. Several of the properties of the original table are preserved: whether a frame is present and any alignment setting. On the other hand, header rows are converted to header columns, and vice versa.
EXAMPLES:
sage: T = table([[1,2,3], [4,5,6]]) sage: T.transpose() 1 4 2 5 3 6 sage: T = table([[1,2,3], [4,5,6]], header_row=['x', 'y', 'z'], frame=True) sage: T.transpose() +---++---+---+ | x || 1 | 4 | +---++---+---+ | y || 2 | 5 | +---++---+---+ | z || 3 | 6 | +---++---+---+