ASCII Art

This file contains:

  • AsciiArt an simple implementation of an ASCII art object,
  • ascii_art() a function to get the ASCII art representation of any object in Sage,
  • several others functions use to get ASCII art representation of primitive python elements (list, tuple, dict, set).

AUTHOR:

  • Jean-Baptiste Priez (2013-04): initial version

EXAMPLES:

sage: n = var('n')
sage: integrate(n^2/x,x)
n^2*log(x)
sage: ascii_art(integrate(n^2/x,x))
 2
n *log(x)
sage: ascii_art(integrate(n^2/(pi*x),x))
 2
n *log(x)
---------
    pi
sage: ascii_art(list(Partitions(6)))
[                                                       * ]
[                                                   **  * ]
[                                      ***      **  *   * ]
[                      ****       ***  *    **  **  *   * ]
[         *****  ****  *     ***  **   *    **  *   *   * ]
[ ******, *    , **  , *   , ***, *  , *  , **, * , * , * ]

This method ascii_art() could be automatically use by the display hook manager activated by the magic function: %display ascii_art:

sage: from sage.repl.interpreter import get_test_shell
sage: shell = get_test_shell()
sage: shell.run_cell('%display ascii_art')
sage: shell.run_cell("i = var('i')")
sage: shell.run_cell('sum(factorial(i)*x^i, i, 0, 10)')
         10           9          8         7        6        5       4      3
3628800*x   + 362880*x  + 40320*x  + 5040*x  + 720*x  + 120*x  + 24*x  + 6*x

     2
+ 2*x  + x + 1
sage: shell.run_cell('3/(7*x)')
 3
---
7*x
sage: shell.run_cell('list(Compositions(5))')
[ *
[ *  **   *        *                   *
[ *  *   **  ***   *   **    *         *   **    *          *
[ *  *   *   *    **  **   ***  ****   *   *    **   ***    *    **     *
[ *, * , * , *  , * , *  , *  , *   , **, ** , ** , **  , ***, *** , ****,

      ]
      ]
      ]
      ]
***** ]
sage: shell.run_cell('%display simple')
                            .      ,    ,              ...
                            .?  .~?$NNO.II7.        ..GOGG
                             ., ~7NNI7NDG$       ...~~~MGG
              ..:IG..       ...G7:DDGNNDO..   ...7:~~~~GNN
              .~~GGGGG...   .O .=$+OD7GI$ ...GG:~+~~~~MG?M.7?
              .~~~D~~GGGGDGOM$..~+IN=NDG.G::D~~~?~~~7?NDI:???G
              .~~~~G:~~G~D:~NONGMMOGD$ND~~::I77~~$?++MN7G GI?D.
               7+I~~DG~~~N:GNGGOD$7OIOOMII::~:I7?G+OGN7G $III?.
                .7==I~~~++IN?+++?$7ND$==$G:G??????N$OG$  ~III?7
                 .$$+++?GG=+G?GDM?GOG:NGMGN7??????D$D~GODIII???.
                   D++++NG+DD$+=GGONGI$DNGDN??????,IN=DOGODN???.
                 , +~+++N??D$I+I=GNMDGDGNIINN??D+:::O~$GGGDIG?7
                :DD.:::OG?G=I~~G7GNM7777NIGODDNNG:::I$GGGGG7??O.
               ~GDDM:::GGMG+?+~$NNN$7IG7NMNMMMN, =::I7GGGGGO???~
              :GDND7?::OOM.D+O~GGDI77777DMGNM$.  ~:,$IGGGGGO???DO.
             OGDDNN.D77OO. $?7==GG777$7GNGMGO.     NOIGGGGGO???G$.
           .OODNNN,DIGDM$GGGGG==GGGGIGNDMDMG,      IGIGGGDON???GG:
          .GODNDM.G$I$IOIOMG$G$?GGGIO,7OD7GG.     ,GDIGGG??????GGG.
         .DGDNI7I7MDI+OOODN$$O,$7DMIN,,IOO77O.   G?$DIGGG?ID???OGG
         GGDNNMMO7GD+OOOGIMOG7::NN====:?MMNGIDD,..IINIGGG?I??DIOGG?
       .7ODMMMN.G7IOGOOODIMG,,:::$=~==::7OGG~IGOMDGMNIGGG????.OG$G.
       ?ODDMNNNO,II$OGODMGDMM?:DMG==~MDINNM$.7$IONDGI?GGG????:$GGG.
    .$MDMNNNNN..:?7GDDDGG,GGM?~:GGGDNND.GIM7D+GI$ON.:?GGG????$$OGG.
  .7DNDDDNMDOGG.=IGGND=7II+N??::$GIIO,IIGMG?7I7G$ON?,IGGG????7GIGG.
  ~GGGDNMMOOGGG$MGMMGDGMDGM?,G:GNG,:IIIGDG7IGGGGG$+NMIGGO?????IGGG.
 .GGGDDMM7OGNGMODMNDDDOO.MII?GI$7IIIIING7GGDMM.IGDG.G7GGGG??$?7GGG
.IGDDDDOINNGMGMDMNDDGDO...$OI+??7OIIIDDGN+$==I=GD ?,NGGGGN7????GGG
 7GGNDM$GONDGDD$MMGNDN. G.:$$G$?$7II$GOO,O=+7O7O~N?OM?GGGGGD+??$GG
 OOGDOI7DGMG..=~DG$DD.  $,,$$$D??7ODOOOODG$777$G OGMM:GGGGGG??GGG.
.$GDDG?7DMOGDNNMGGDGG ..,=O7$GG$+O$$OG=+O:GI77G$. ...DIGGGGI?$GGG.
.OGGGGO7OGDGGNGGGDGG.  O:,77$O$$$D     $GN:7777GD   ..$GGGG??GGG$.
.GGGGDI GD.~NOGDGGG    MG,777G77D7      +$~D77777=   ..7GGG???GGO.
  GGD.   .~NODN...   ..D::77O$7G77      .OG:G???G7.    7$NOM??GG=.
    .     . .      .+~~DD~77$G7OD7      .?GGO?$OM$D     ?????DGG...
                   7I77DN$II7$M.G$G      . .:G?==$G     .?????D??~
                 . .:IIIGO7O$GN..O$         7I=~+?I.    =???7? GGIG
                  $,III7NGGNNNG, .O.         O====7I.  .DG??$?. GG?G
                  .$7III$77777$$~  .          +====D$GG ~$???:  .$GIG.
                 :.+IIII$77$G$$O,+            OI==+7I$7=.:???     .GG$.
                 ,,III$I7?I7$$OG7D            ?+,==+77G?$,???.      GG?
                 ?IIIII=+$I77777             .:++=+++O77:,??:         GG.
                 .IIIIG+III77777.             7,=,++?II7$,?G          .GO .
                  $OII7?OIIIIIO              .I:++??IIIII???.           I$ .
                  .DNGDMOIG777.                +~++?I$IIMN?,             .G,
                   .G.I?IIDGII~                .OG??$$MIMGI.               G,
                    N+?II7OGI7.                  DD?$GGDGID.                 :
                     =?IIOOI$.                    ?~~GGG$II                  .+.
                    ,7=IINGI                       ?=IGGGI?.
                    G,+IGOII                        ?+II7??+
                   .,:?IGOII                         ?+GIOII
                 .:N+=?IMGI7=.                       .~:$I?IO.
               .$:IGO?$IIIII7+.                       O::I7I?.
              .:::=IIGIIIIIII.                        .~,$IG?IO
             .+:$IIIIMIII7G$?.                         I::I7IIG7
             .$I$+7IIIMMMG7I7                          ?G,DGGNII.
             .$~:$IIGMNGND77I:                          +I$GOD=?=
            ?=?IIIIGIIIINI7777?                        .7~=~===?.
          ONGNDG??IG?III$N7I777                          D~====I
        .:$??7IIIIIII.....,....                          O::==~$D.
        .,........ ..                                  ..M:I.==$7G.
                                                        I?::IIIII7.
                                                       .~:G:IIIIIG.
                                                       .$:,O7III$$O
                                                         ::~DOGGNNO
                                                         .::,IOODI,
                                                           .7????$.
                                                             ... .
class sage.misc.ascii_art.AsciiArt(lines=, []breakpoints=, []baseline=None, atomic=True)

Bases: sage.structure.sage_object.SageObject

An Ascii art object is an object with some specific representation for printing.

INPUT:

  • lines – the list of lines of the representation of the ascii art object
  • breakpoints – the list of points where the representation can be split
  • baseline – the reference line (from the bottom)
  • atomic – indicate if the ascii art representation is splittable (must be coherent with breakpoints)

EXAMPLES:

sage: i = var('i')
sage: ascii_art(sum(pi^i/factorial(i)*x^i, i, 0, oo))
 pi*x
e
get_baseline()

Return the line where the baseline is, for example:

    5      4
14*x  + 5*x

the baseline has at line \(0\) and

{ o       }
{  \  : 4 }
{   o     }

has at line \(1\).

TESTS:

sage: from sage.misc.ascii_art import AsciiArt
sage: aa = AsciiArt(["   *   ", "  * *  ", " *   * ", "*******"], baseline=1);aa
   *
  * *
 *   *
*******
sage: aa.get_baseline()
1
sage: b = AsciiArt(["<-"])
sage: aa+b
   *
  * *
 *   * <-
*******
get_breakpoints()

Return an iterator of breakpoints where the object can be split.

For example the expression:

   5    4
14x + 5x

can be split on position 4 (on the +).

EXAMPLES:

sage: from sage.misc.ascii_art import AsciiArt
sage: p3 = AsciiArt([" * ", "***"])
sage: p5 = AsciiArt(["  *  ", " * * ", "*****"])
sage: aa = ascii_art([p3, p5])
sage: aa.get_breakpoints()
[2, 5, 6, 7, 12]
is_atomic()

Return True if the AsciiArt object is not splitable and False in otherwise.

For example, we considere a linear expression:

sage: a = 14*x^5 + 5*x^4
sage: ascii_art(a)
    5      4
14*x  + 5*x

If ASCII art object is not atomic, it is splittable on the + (in fact it is not really true because we use sympy to make ASCII art).

TESTS:

sage: from sage.misc.ascii_art import AsciiArt
sage: aa = AsciiArt(["  *  ", " * * ", "*****"]); aa
  *
 * *
*****
sage: aa.is_atomic()
True
sage: laa = ascii_art([aa,aa])
sage: laa.is_atomic()
False
split(pos)

Split the representation at the position pos.

EXMAPLES:

sage: from sage.misc.ascii_art import AsciiArt
sage: p3 = AsciiArt([" * ", "***"])
sage: p5 = AsciiArt(["  *  ", " * * ", "*****"])
sage: aa = ascii_art([p3, p5])
sage: a,b= aa.split(6)
sage: a
[
[  *
[ ***,
sage: b
   *   ]
  * *  ]
 ***** ]
sage.misc.ascii_art.ascii_art(obj)

Return an ASCII art reprensentation of obj:

sage: ascii_art(integral(exp(x+x^2)/(x+1), x))
    /
   |
   |   2
   |  x  + x
   | e
   | ------- dx
   |  x + 1
   |
  /

TESTS:

sage: n = var('n')
sage: ascii_art(sum(binomial(2 * n, n + 1) * x^n, n, 0, oo))
 /        __________    \
-\2*x + \/ -4*x + 1  - 1/
--------------------------
           __________
     2*x*\/ -4*x + 1
sage: ascii_art(list(DyckWords(3)))
[                                   /\   ]
[            /\    /\      /\/\    /  \  ]
[ /\/\/\, /\/  \, /  \/\, /    \, /    \ ]
sage: ascii_art(1)
1
sage.misc.ascii_art.ascii_art_dict(dict)

Return an ASCII art output of a dictionnary.

TESTS:

sage: ascii_art({i:dw for i,dw in enumerate(DyckWords(3))})
{                                             /\   }
{                /\      /\        /\/\      /  \  }
{ 0:/\/\/\, 1:/\/  \, 2:/  \/\, 3:/    \, 4:/    \ }
sage.misc.ascii_art.ascii_art_list(list)

Return an ASCII art output of a list.

TESTS:

sage: ascii_art(list(DyckWords(3)))
[                                   /\   ]
[            /\    /\      /\/\    /  \  ]
[ /\/\/\, /\/  \, /  \/\, /    \, /    \ ]
sage.misc.ascii_art.ascii_art_set(set)

Return an ASCII art output of a set.

TESTS:

sage: ascii_art(set(DyckWords(3)))
{                                   /\   }
{  /\      /\/\              /\    /  \  }
{ /  \/\, /    \, /\/\/\, /\/  \, /    \ }
sage.misc.ascii_art.ascii_art_tuple(tuple)

Return an ASCII art output of a tuple.

TESTS:

sage: ascii_art(tuple(DyckWords(3)))
(                                   /\   )
(            /\    /\      /\/\    /  \  )
( /\/\/\, /\/  \, /  \/\, /    \, /    \ )

Previous topic

Abstract methods

Next topic

Bindable classes

This Page