/usr/share/doc/maxima-doc/html/maxima

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on January, 10 2014 by texi2html 1.76 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
            Karl Berry  <karl@freefriends.org>
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
            and many others.
Maintained by: Many creative people <dev@texi2html.cvshome.org>
Send bugs and suggestions to <users@texi2html.cvshome.org>

-->
<head>
<title>Maxima 5.32.1 Manual: 77. stringproc</title>

<meta name="description" content="Maxima 5.32.1 Manual: 77. stringproc">
<meta name="keywords" content="Maxima 5.32.1 Manual: 77. stringproc">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.76">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
body
{
    color: black;
    background: white; 
    margin-left: 8%;
    margin-right: 13%;
}

h1
{
    margin-left: +8%;
    font-size: 150%;
    font-family: sans-serif
}

h2
{
    font-size: 125%;
    font-family: sans-serif
}

h3
{
    font-size: 100%;
    font-family: sans-serif
}

h2,h3,h4,h5,h6 { margin-left: +4%; }

div.textbox
{
    border: solid;
    border-width: thin;
    /* width: 100%; */
    padding-top: 1em;
    padding-bottom: 1em;
    padding-left: 2em;
    padding-right: 2em
}

div.titlebox
{
    border: none;
    padding-top: 1em;
    padding-bottom: 1em;
    padding-left: 2em;
    padding-right: 2em;
    background: rgb(200,255,255);
    font-family: sans-serif
}

div.synopsisbox
{
    border: none;
    padding-top: 1em;
    padding-bottom: 1em;
    padding-left: 2em;
    padding-right: 2em;
     background: rgb(255,220,255);
    /*background: rgb(200,255,255); */
    /* font-family: fixed */
}

pre.example
{
    border: 1px solid gray;
    padding-top: 1em;
    padding-bottom: 1em;
    padding-left: 1em;
    padding-right: 1em;
    /* background: rgb(247,242,180); */ /* kind of sandy */
    /* background: rgb(200,255,255); */ /* sky blue */
    background-color: #F1F5F9; /* light blue-gray */
    /* font-family: "Lucida Console", monospace */
}

div.spacerbox
{
    border: none;
    padding-top: 2em;
    padding-bottom: 2em
}

div.image
{
    margin: 0;
    padding: 1em;
    text-align: center;
}

div.categorybox
{
    border: 1px solid gray;
    padding-top: 0px;
    padding-bottom: 0px;
    padding-left: 1em;
    padding-right: 1em;
    background: rgb(247,242,220);
}


-->
</style>

<link rel="icon" href="http://maxima.sourceforge.net/favicon.ico"/>
</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">

<a name="stringproc"></a>
<a name="SEC361"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="maxima_76.html#SEC360" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC362" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima_76.html#SEC359" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="maxima_82.html#SEC380" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="chapter"> 77. stringproc </h1>

<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#SEC362">77.1 Introduction to string processing</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC363">77.2 Functions and Variables for input and output</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC364">77.3 Functions and Variables for characters</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top"><a href="#SEC365">77.4 Functions and Variables for strings</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

<p><a name="Item_003a-Introduction-to-string-processing"></a>
</p><hr size="6">
<a name="Introduction-to-string-processing"></a>
<a name="SEC362"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC361" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC363" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="#SEC361" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC361" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="maxima_82.html#SEC380" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 77.1 Introduction to string processing </h2>

<p><code>stringproc.lisp</code> enlarges Maximas capabilities of working with strings 
and adds some useful functions for file in/output.
</p>
<p>For questions and bugs please mail to volkervannek at gmail dot com .
</p>
<p>In Maxima a string is easily constructed by typing &quot;text&quot;.
<code>stringp</code> tests for strings.
</p>
<pre class="example">(%i1) m: &quot;text&quot;;
(%o1)                         text
(%i2) stringp(m);
(%o2)                         true
</pre>
<p>Characters are represented as strings of length 1.
These are not Lisp characters.
Tests can be done with <code>charp</code> (respectively <code>lcharp</code>
and conversion from Lisp to Maxima characters with <code>cunlisp</code>).
</p>

<pre class="example">(%i1) c: &quot;e&quot;;
(%o1)                           e
(%i2) [charp(c),lcharp(c)];
(%o2)                     [true, false]
(%i3) supcase(c);
(%o3)                           E
(%i4) charp(%);
(%o4)                         true
</pre>
<p>All functions in <code>stringproc.lisp</code> that return characters, return Maxima-characters.
Due to the fact, that the introduced characters are strings of length 1,
you can use a lot of string functions also for characters.
As seen, <code>supcase</code> is one example.
</p>
<p>It is important to know,
that the first character in a Maxima-string is at position 1.
This is designed due to the fact that the first element in a Maxima-list is at position 1 too.
See definitions of <code>charat</code> and <code>charlist</code> for examples.
</p>
<p>In applications string-functions are often used when working with files.
You will find some useful stream- and print-functions in <code>stringproc.lisp</code>.
The following example shows some of the here introduced functions at work.
</p>
<p>Example: 
</p>
<p><code>openw</code> returns an output stream to a file, <code>printf</code> then allows formatted writing 
to this file. See <code>printf</code> for details.
</p>
<pre class="example">(%i1) s: openw(&quot;E:/file.txt&quot;);
(%o1)                    #&lt;output stream E:/file.txt&gt;
(%i2) for n:0 thru 10 do printf( s, &quot;~d &quot;, fib(n) );
(%o2)                                done
(%i3) printf( s, &quot;~%~d ~f ~a ~a ~f ~e ~a~%&quot;, 
              42,1.234,sqrt(2),%pi,1.0e-2,1.0e-2,1.0b-2 );
(%o3)                                false
(%i4) close(s);
(%o4)                                true
</pre>
<p>After closing the stream you can open it again, this time with input direction. 
<code>readline</code> returns the entire line as one string. The <code>stringproc</code> package 
now offers a lot of functions for manipulating strings. Tokenizing can be done by 
<code>split</code> or <code>tokens</code>.
</p>
<pre class="example">(%i5) s: openr(&quot;E:/file.txt&quot;);
(%o5)                     #&lt;input stream E:/file.txt&gt;
(%i6) readline(s);
(%o6)                     0 1 1 2 3 5 8 13 21 34 55 
(%i7) line: readline(s);
(%o7)               42 1.234 sqrt(2) %pi 0.01 1.0E-2 1.0b-2
(%i8) list: tokens(line);
(%o8)           [42, 1.234, sqrt(2), %pi, 0.01, 1.0E-2, 1.0b-2]
(%i9) map( parse_string, list );
(%o9)            [42, 1.234, sqrt(2), %pi, 0.01, 0.01, 1.0b-2]
(%i10) float(%);
(%o10) [42.0, 1.234, 1.414213562373095, 3.141592653589793, 0.01,
                                                     0.01, 0.01]
(%i11) readline(s);
(%o11)                               false
(%i12) close(s)$
</pre>
<p><code>readline</code> returns <code>false</code> when the end of file occurs.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Strings} &middot;
@ref{Category: Share packages} &middot;
@ref{Category: Package stringproc}
</div>
</p>

<p><a name="Item_003a-Functions-and-Variables-for-input-and-output"></a>
</p><hr size="6">
<a name="Functions-and-Variables-for-input-and-output"></a>
<a name="SEC363"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC362" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC364" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="#SEC361" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC361" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="maxima_82.html#SEC380" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 77.2 Functions and Variables for input and output </h2>

<p>Example: 
</p>
<pre class="example">(%i1) s: openw(&quot;E:/file.txt&quot;);
(%o1)                     #&lt;output stream E:/file.txt&gt;
(%i2) control: 
&quot;~2tAn atom: ~20t~a~%~2tand a list: ~20t~{~r ~}~%~2t\
and an integer: ~20t~d~%&quot;$
(%i3) printf( s,control, 'true,[1,2,3],42 )$
(%o3)                                false
(%i4) close(s);
(%o4)                                true
(%i5) s: openr(&quot;E:/file.txt&quot;);
(%o5)                     #&lt;input stream E:/file.txt&gt;
(%i6) while stringp( tmp:readline(s) ) do print(tmp)$
  An atom:          true 
  and a list:       one two three  
  and an integer:   42 
(%i7) close(s)$
</pre>
<p><a name="Item_003a-close"></a>
</p><dl>
<dt><u>Function:</u> <b>close</b><i> (<var>stream</var>) </i>
<a name="IDX2709"></a>
</dt>
<dd><p>Closes <var>stream</var> and returns <code>true</code> if <var>stream</var> had been open. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File input} &middot;
@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-flength"></a>
</p><dl>
<dt><u>Function:</u> <b>flength</b><i> (<var>stream</var>)</i>
<a name="IDX2710"></a>
</dt>
<dd><p>Returns the number of elements in <var>stream</var>
where <var>stream</var> has to be a stream from or to a file. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File input} &middot;
@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-fposition"></a>
</p><dl>
<dt><u>Function:</u> <b>fposition</b><i> (<var>stream</var>)</i>
<a name="IDX2711"></a>
</dt>
<dt><u>Function:</u> <b>fposition</b><i> (<var>stream</var>, <var>pos</var>)</i>
<a name="IDX2712"></a>
</dt>
<dd><p>Returns the current position in <var>stream</var>, if <var>pos</var> is not used. 
If <var>pos</var> is used, <code>fposition</code> sets the position in <var>stream</var>.
<var>stream</var> has to be a stream from or to a file and 
<var>pos</var> has to be a positive number where the first element in <var>stream</var> 
is in position 1.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File input} &middot;
@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-freshline"></a>
</p><dl>
<dt><u>Function:</u> <b>freshline</b><i> () </i>
<a name="IDX2713"></a>
</dt>
<dt><u>Function:</u> <b>freshline</b><i> (<var>stream</var>) </i>
<a name="IDX2714"></a>
</dt>
<dd><p>Writes a new line (to <var>stream</var>),
if the position is not at the beginning of a line.
See also <code>newline</code>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="get_005foutput_005fstream_005fstring"></a>
<a name="Item_003a-get_005foutput_005fstream_005fstring"></a>
</p><dl>
<dt><u>Function:</u> <b>get_output_stream_string</b><i> (<var>stream</var>)</i>
<a name="IDX2715"></a>
</dt>
<dd><p>Returns a string containing all the characters currently present in 
<var>stream</var> which must be an open string-output stream. 
The returned characters are removed from <var>stream</var>.
</p>
<p>Example: See <a href="#make_005fstring_005foutput_005fstream">make_string_output_stream</a> .
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="make_005fstring_005finput_005fstream"></a>
<a name="Item_003a-make_005fstring_005finput_005fstream"></a>
</p><dl>
<dt><u>Function:</u> <b>make_string_input_stream</b><i> (<var>string</var>)</i>
<a name="IDX2716"></a>
</dt>
<dt><u>Function:</u> <b>make_string_input_stream</b><i> (<var>string</var>, <var>start</var>)</i>
<a name="IDX2717"></a>
</dt>
<dt><u>Function:</u> <b>make_string_input_stream</b><i> (<var>string</var>, <var>start</var>, <var>end</var>)</i>
<a name="IDX2718"></a>
</dt>
<dd><p>Returns an input stream which contains parts of <var>string</var> and an end of file. 
Without optional arguments the stream contains the entire string 
and is positioned in front of the first character. 
<var>start</var> and <var>end</var> define the substring contained in the stream. 
The first character is available at position 1.
</p> 
<pre class="example">(%i1) istream : make_string_input_stream(&quot;text&quot;, 1, 4);
(%o1)              #&lt;string-input stream from &quot;text&quot;&gt;
(%i2) (while (c : readchar(istream)) # false do sprint(c), newline())$
t e x 
(%i3) close(istream)$
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="make_005fstring_005foutput_005fstream"></a>
<a name="Item_003a-make_005fstring_005foutput_005fstream"></a>
</p><dl>
<dt><u>Function:</u> <b>make_string_output_stream</b><i> ()</i>
<a name="IDX2719"></a>
</dt>
<dd><p>Returns an output stream that accepts characters. Characters currently present 
in this stream can be retrieved by <a href="#get_005foutput_005fstream_005fstring">get_output_stream_string</a>.
</p> 
<pre class="example">(%i1) ostream : make_string_output_stream();
(%o1)               #&lt;string-output stream 09622ea0&gt;
(%i2) printf(ostream, &quot;foo&quot;)$

(%i3) printf(ostream, &quot;bar&quot;)$

(%i4) string : get_output_stream_string(ostream);
(%o4)                            foobar
(%i5) printf(ostream, &quot;baz&quot;)$

(%i6) string : get_output_stream_string(ostream);
(%o6)                              baz
(%i7) close(ostream)$
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-newline"></a>
</p><dl>
<dt><u>Function:</u> <b>newline</b><i> () </i>
<a name="IDX2720"></a>
</dt>
<dt><u>Function:</u> <b>newline</b><i> (<var>stream</var>) </i>
<a name="IDX2721"></a>
</dt>
<dd><p>Writes a new line (to <var>stream</var>).
See <code>sprint</code> for an example of using <code>newline()</code>.
Note that there are some cases, where <code>newline()</code> does not work as expected. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-opena"></a>
</p><dl>
<dt><u>Function:</u> <b>opena</b><i> (<var>file</var>) </i>
<a name="IDX2722"></a>
</dt>
<dd><p>Returns an output stream to <var>file</var>.
If an existing file is opened, <code>opena</code> appends elements at the end of file.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-openr"></a>
</p><dl>
<dt><u>Function:</u> <b>openr</b><i> (<var>file</var>) </i>
<a name="IDX2723"></a>
</dt>
<dd><p>Returns an input stream to <var>file</var>.
If <var>file</var> does not exist, it will be created.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File input} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-openw"></a>
</p><dl>
<dt><u>Function:</u> <b>openw</b><i> (<var>file</var>) </i>
<a name="IDX2724"></a>
</dt>
<dd><p>Returns an output stream to <var>file</var>.
If <var>file</var> does not exist, it will be created.
If an existing file is opened, <code>openw</code> destructively modifies <var>file</var>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-printf"></a>
</p><dl>
<dt><u>Function:</u> <b>printf</b><i> (<var>dest</var>, <var>string</var>)</i>
<a name="IDX2725"></a>
</dt>
<dt><u>Function:</u> <b>printf</b><i> (<var>dest</var>, <var>string</var>, <var>expr_1</var>, ..., <var>expr_n</var>)</i>
<a name="IDX2726"></a>
</dt>
<dd><p>Produces formatted output by outputting the characters of control-string 
<var>string</var> and observing that a tilde introduces a directive.
The character after the tilde, possibly preceded by prefix parameters 
and modifiers, specifies what kind of formatting is desired.
Most directives use one or more elements of the arguments 
<var>expr_1</var>, ..., <var>expr_n</var> to create their output.
</p>
<p>If <var>dest</var> is a stream or <code>true</code>, then <code>printf</code> returns <code>false</code>.
Otherwise, <code>printf</code> returns a string containing the output.
</p>
<p><code>printf</code> provides the Common Lisp function <code>format</code> in Maxima. 
The following example illustrates the general relation between these two 
functions.
</p>
<pre class="example">(%i1) printf(true, &quot;R~dD~d~%&quot;, 2, 2);
R2D2
(%o1)                                false
(%i2) :lisp (format t &quot;R~dD~d~%&quot; 2 2)
R2D2
NIL
</pre>
<p>The following description is limited to a rough sketch of the possibilities of 
<code>printf</code>.
The Lisp function <code>format</code> is described in detail in many reference books. 
Of good help is e.g. the free available online-manual 
&quot;Common Lisp the Language&quot; by Guy L. Steele. See chapter 22.3.3 there. 
</p>
<pre class="example">   ~%       new line
   ~&amp;       fresh line
   ~t       tab
   ~$       monetary
   ~d       decimal integer
   ~b       binary integer
   ~o       octal integer
   ~x       hexadecimal integer
   ~br      base-b integer
   ~r       spell an integer
   ~p       plural
   ~f       floating point
   ~e       scientific notation
   ~g       ~f or ~e, depending upon magnitude
   ~h       bigfloat
   ~a       uses Maxima function string
   ~s       like ~a, but output enclosed in &quot;double quotes&quot;
   ~~       ~
   ~&lt;       justification, ~&gt; terminates
   ~(       case conversion, ~) terminates 
   ~[       selection, ~] terminates 
   ~{       iteration, ~} terminates
</pre>
<p>The directive ~h for bigfloat is no Lisp-standard and is therefore illustrated below. 
</p>
<p>Note that the directive ~* is not supported.
</p>
<p>If <var>dest</var> is a stream or <code>true</code>, then <code>printf</code> returns <code>false</code>.
Otherwise, <code>printf</code> returns a string containing the output.
</p>
<pre class="example">(%i1) printf( false, &quot;~a ~a ~4f ~a ~@r&quot;, 
              &quot;String&quot;,sym,bound,sqrt(12),144), bound = 1.234;
(%o1)                 String sym 1.23 2*sqrt(3) CXLIV
(%i2) printf( false,&quot;~{~a ~}&quot;,[&quot;one&quot;,2,&quot;THREE&quot;] );
(%o2)                          one 2 THREE 
(%i3) printf(true,&quot;~{~{~9,1f ~}~%~}&quot;,mat ),
          mat = args(matrix([1.1,2,3.33],[4,5,6],[7,8.88,9]))$
      1.1       2.0       3.3 
      4.0       5.0       6.0 
      7.0       8.9       9.0 
(%i4) control: &quot;~:(~r~) bird~p ~[is~;are~] singing.&quot;$
(%i5) printf( false,control, n,n,if n=1 then 1 else 2 ), n=2;
(%o5)                    Two birds are singing.
</pre>
<p>The directive ~h has been introduced to handle bigfloats. 
</p>
<pre class="example">~w,d,e,x,o,p@H
 w : width
 d : decimal digits behind floating point
 e : minimal exponent digits
 x : preferred exponent
 o : overflow character
 p : padding character
 @ : display sign for positive numbers
</pre>
<pre class="example">(%i1) fpprec : 1000$
(%i2) printf(true, &quot;|~h|~%&quot;, 2.b0^-64)$
|0.0000000000000000000542101086242752217003726400434970855712890625|
(%i3) fpprec : 26$
(%i4) printf(true, &quot;|~h|~%&quot;, sqrt(2))$
|1.4142135623730950488016887|
(%i5) fpprec : 24$
(%i6) printf(true, &quot;|~h|~%&quot;, sqrt(2))$
|1.41421356237309504880169|
(%i7) printf(true, &quot;|~28h|~%&quot;, sqrt(2))$
|   1.41421356237309504880169|
(%i8) printf(true, &quot;|~28,,,,,'*h|~%&quot;, sqrt(2))$
|***1.41421356237309504880169|
(%i9) printf(true, &quot;|~,18h|~%&quot;, sqrt(2))$
|1.414213562373095049|
(%i10) printf(true, &quot;|~,,,-3h|~%&quot;, sqrt(2))$
|1414.21356237309504880169b-3|
(%i11) printf(true, &quot;|~,,2,-3h|~%&quot;, sqrt(2))$
|1414.21356237309504880169b-03|
(%i12) printf(true, &quot;|~20h|~%&quot;, sqrt(2))$
|1.41421356237309504880169|
(%i13) printf(true, &quot;|~20,,,,'+h|~%&quot;, sqrt(2))$
|++++++++++++++++++++|
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: File output} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="readchar"></a>
<a name="Item_003a-readchar"></a>
</p><dl>
<dt><u>Function:</u> <b>readchar</b><i> (<var>stream</var>)</i>
<a name="IDX2727"></a>
</dt>
<dd><p>Removes and returns the first character in <var>stream</var>. 
If the end of file is encountered <code>readchar</code> returns <code>false</code>.
</p>
<p>Example: See <a href="#make_005fstring_005finput_005fstream">make_string_input_stream</a>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File input} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-readline"></a>
</p><dl>
<dt><u>Function:</u> <b>readline</b><i> (<var>stream</var>) </i>
<a name="IDX2728"></a>
</dt>
<dd><p>Returns a string containing the characters from the current position 
in <var>stream</var> up to the end of the line or <code>false</code> 
if the end of the file is encountered.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: File input} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="sprint"></a>
<a name="Item_003a-sprint"></a>
</p><dl>
<dt><u>Function:</u> <b>sprint</b><i> (<var>expr_1</var>, &hellip;, <var>expr_n</var>)</i>
<a name="IDX2729"></a>
</dt>
<dd><p>Evaluates and displays its arguments one after the other `on a line' starting at
the leftmost position.  The numbers are printed with the '-' right next to the
number, and it disregards line length.  <code>newline()</code>, which will be
autoloaded from <code>stringproc.lisp</code> might be useful, if you whish to place
intermediate line breaking.
</p>
<p>Example:
</p>
<pre class="example">(%i1) for n:0 thru 19 do sprint( fib(n) )$
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597 2584 4181
(%i2) for n:0 thru 22 do ( 
         sprint(fib(n)), if mod(n,10)=9 then newline() )$
0 1 1 2 3 5 8 13 21 34 
55 89 144 233 377 610 987 1597 2584 4181 
6765 10946 17711 
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p></dd></dl>

<p><a name="Item_003a-Functions-and-Variables-for-characters"></a>
</p><hr size="6">
<a name="Functions-and-Variables-for-characters"></a>
<a name="SEC364"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC363" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC365" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="#SEC361" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC361" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="maxima_82.html#SEC380" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 77.3 Functions and Variables for characters </h2>

<p><a name="Item_003a-alphacharp"></a>
</p><dl>
<dt><u>Function:</u> <b>alphacharp</b><i> (<var>char</var>)    </i>
<a name="IDX2730"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char</var> is an alphabetic character. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-alphanumericp"></a>
</p><dl>
<dt><u>Function:</u> <b>alphanumericp</b><i> (<var>char</var>) </i>
<a name="IDX2731"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char</var> is an alphabetic character or a digit. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-ascii"></a>
</p><dl>
<dt><u>Function:</u> <b>ascii</b><i> (<var>int</var>) </i>
<a name="IDX2732"></a>
</dt>
<dd><p>Returns the character corresponding to the ASCII number <var>int</var>.
( -1 &lt; int &lt; 256 )
</p>
<pre class="example">(%i1) for n from 0 thru 255 do ( 
   tmp: ascii(n), if alphacharp(tmp) then sprint(tmp),
      if n=96 then newline() )$
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 
a b c d e f g h i j k l m n o p q r s t u v w x y z
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-cequal"></a>
</p><dl>
<dt><u>Function:</u> <b>cequal</b><i> (<var>char_1</var>, <var>char_2</var>)          </i>
<a name="IDX2733"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char_1</var> and <var>char_2</var> are the same. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-cequalignore"></a>
</p><dl>
<dt><u>Function:</u> <b>cequalignore</b><i> (<var>char_1</var>, <var>char_2</var>)    </i>
<a name="IDX2734"></a>
</dt>
<dd><p>Like <code>cequal</code> but ignores case. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-cgreaterp"></a>
</p><dl>
<dt><u>Function:</u> <b>cgreaterp</b><i> (<var>char_1</var>, <var>char_2</var>)       </i>
<a name="IDX2735"></a>
</dt>
<dd><p>Returns <code>true</code> if the ASCII number of <var>char_1</var> is greater than the number of <var>char_2</var>. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-cgreaterpignore"></a>
</p><dl>
<dt><u>Function:</u> <b>cgreaterpignore</b><i> (<var>char_1</var>, <var>char_2</var>)</i>
<a name="IDX2736"></a>
</dt>
<dd><p>Like <code>cgreaterp</code> but ignores case. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-charp"></a>
</p><dl>
<dt><u>Function:</u> <b>charp</b><i> (<var>obj</var>) </i>
<a name="IDX2737"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>obj</var> is a Maxima-character.
See introduction for example.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-cint"></a>
</p><dl>
<dt><u>Function:</u> <b>cint</b><i> (<var>char</var>) </i>
<a name="IDX2738"></a>
</dt>
<dd><p>Returns the ASCII number of <var>char</var>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-clessp"></a>
</p><dl>
<dt><u>Function:</u> <b>clessp</b><i> (<var>char_1</var>, <var>char_2</var>)</i>
<a name="IDX2739"></a>
</dt>
<dd><p>Returns <code>true</code> if the ASCII number of <var>char_1</var> is less than the number of <var>char_2</var>. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-clesspignore"></a>
</p><dl>
<dt><u>Function:</u> <b>clesspignore</b><i> (<var>char_1</var>, <var>char_2</var>)</i>
<a name="IDX2740"></a>
</dt>
<dd><p>Like <code>clessp</code> but ignores case. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-constituent"></a>
</p><dl>
<dt><u>Function:</u> <b>constituent</b><i> (<var>char</var>)   </i>
<a name="IDX2741"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char</var> is a graphic character and not the space character.
A graphic character is a character one can see, plus the space character.
(<code>constituent</code> is defined by Paul Graham, ANSI Common Lisp, 1996, page 67.)
</p>
<pre class="example">(%i1) for n from 0 thru 255 do ( 
tmp: ascii(n), if constituent(tmp) then sprint(tmp) )$
! &quot; #  %  ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; &lt; = &gt; ? @ A B
C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a b c
d e f g h i j k l m n o p q r s t u v w x y z { | } ~
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-cunlisp"></a>
</p><dl>
<dt><u>Function:</u> <b>cunlisp</b><i> (<var>lisp_char</var>) </i>
<a name="IDX2742"></a>
</dt>
<dd><p>Converts a Lisp-character into a Maxima-character.
(You won't need it.)
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-digitcharp"></a>
</p><dl>
<dt><u>Function:</u> <b>digitcharp</b><i> (<var>char</var>)    </i>
<a name="IDX2743"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char</var> is a digit. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-lcharp"></a>
</p><dl>
<dt><u>Function:</u> <b>lcharp</b><i> (<var>obj</var>) </i>
<a name="IDX2744"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>obj</var> is a Lisp-character.
(You won't need it.)
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-lowercasep"></a>
</p><dl>
<dt><u>Function:</u> <b>lowercasep</b><i> (<var>char</var>)    </i>
<a name="IDX2745"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char</var> is a lowercase character. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>


<dl>
<dt><u>Variable:</u> <b>newline</b>
<a name="IDX2746"></a>
</dt>
<dd><p>The newline character. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Global variables} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-space"></a>
</p><dl>
<dt><u>Variable:</u> <b>space</b>
<a name="IDX2747"></a>
</dt>
<dd><p>The space character.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Global variables} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-tab"></a>
</p><dl>
<dt><u>Variable:</u> <b>tab</b>
<a name="IDX2748"></a>
</dt>
<dd><p>The tab character.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Global variables} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-uppercasep"></a>
</p><dl>
<dt><u>Function:</u> <b>uppercasep</b><i> (<var>char</var>)    </i>
<a name="IDX2749"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>char</var> is an uppercase character. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-Functions-and-Variables-for-strings"></a>
</p><hr size="6">
<a name="Functions-and-Variables-for-strings"></a>
<a name="SEC365"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC364" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="#SEC361" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="#SEC361" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="maxima_82.html#SEC380" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h2 class="section"> 77.4 Functions and Variables for strings </h2>

<p><a name="base64"></a>
<a name="Item_003a-base64"></a>
</p><dl>
<dt><u>Function:</u> <b>base64</b><i> (<var>string</var>)</i>
<a name="IDX2750"></a>
</dt>
<dd><p>Returns the base64-representation of <var>string</var> as a string.
</p>
<p>Example:
</p>
<pre class="example">(%i1) base64 : base64(&quot;foo bar baz&quot;);
(%o1)                       Zm9vIGJhciBiYXo=
(%i2) string : base64_decode(base64);
(%o2)                          foo bar baz
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="base64_005fdecode"></a>
<a name="Item_003a-base64_005fdecode"></a>
</p><dl>
<dt><u>Function:</u> <b>base64_decode</b><i> (<var>base64-string</var>)</i>
<a name="IDX2751"></a>
</dt>
<dd><p>Decodes the string <var>base64-string</var> coded in base64 back to the original string.
</p>
<p>Example: See <a href="#base64">base64</a>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-charat"></a>
</p><dl>
<dt><u>Function:</u> <b>charat</b><i> (<var>string</var>, <var>n</var>) </i>
<a name="IDX2752"></a>
</dt>
<dd><p>Returns the <var>n</var>-th character of <var>string</var>.
The first character in <var>string</var> is returned with <var>n</var> = 1.
</p>
<pre class="example">(%i1) charat(&quot;Lisp&quot;,1);
(%o1)                           L
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-charlist"></a>
</p><dl>
<dt><u>Function:</u> <b>charlist</b><i> (<var>string</var>) </i>
<a name="IDX2753"></a>
</dt>
<dd><p>Returns the list of all characters in <var>string</var>. 
</p>
<pre class="example">(%i1) charlist(&quot;Lisp&quot;);
(%o1)                     [L, i, s, p]
(%i2) %[1];
(%o2)                           L
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-eval_005fstring"></a>
</p><dl>
<dt><u>Function:</u> <b>eval_string</b><i> (<var>str</var>)</i>
<a name="IDX2754"></a>
</dt>
<dd><p>Parse the string <var>str</var> as a Maxima expression and evaluate it.
The string <var>str</var> may or may not have a terminator (dollar sign <code>$</code> or semicolon <code>;</code>).
Only the first expression is parsed and evaluated, if there is more than one.
</p>
<p>Complain if <var>str</var> is not a string.
</p>
<p>Examples:
</p>
<pre class="example">(%i1) eval_string (&quot;foo: 42; bar: foo^2 + baz&quot;);
(%o1)                       42
(%i2) eval_string (&quot;(foo: 42, bar: foo^2 + baz)&quot;);
(%o2)                   baz + 1764
</pre>
<p>See also <code>parse_string</code>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="md5sum"></a>
<a name="Item_003a-md5sum"></a>
</p><dl>
<dt><u>Function:</u> <b>md5sum</b><i> (<var>string</var>)</i>
<a name="IDX2755"></a>
</dt>
<dd><p>Returns the md5 checksum of a <var>string</var> as a string. To parse the returned 
value into an integer please set the input base to 16 and prefix the string by zero.
</p>
<p>Example:
</p>
<pre class="example">(%i1) string : md5sum(&quot;foo bar baz&quot;);
(%o1)                  ab07acbb1e496801937adfa772424bf7
(%i2) ibase : obase : 16.$

(%i3) integer : parse_string(sconcat(0, string));
(%o3)                 0ab07acbb1e496801937adfa772424bf7
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-parse_005fstring"></a>
</p><dl>
<dt><u>Function:</u> <b>parse_string</b><i> (<var>str</var>)</i>
<a name="IDX2756"></a>
</dt>
<dd><p>Parse the string <var>str</var> as a Maxima expression (do not evaluate it).
The string <var>str</var> may or may not have a terminator (dollar sign <code>$</code> or semicolon <code>;</code>).
Only the first expression is parsed, if there is more than one.
</p>
<p>Complain if <var>str</var> is not a string.
</p>
<p>Examples:
</p>
<pre class="example">(%i1) parse_string (&quot;foo: 42; bar: foo^2 + baz&quot;);
(%o1)                    foo : 42
(%i2) parse_string (&quot;(foo: 42, bar: foo^2 + baz)&quot;);
                                   2
(%o2)          (foo : 42, bar : foo  + baz)
</pre>
<p>See also <code>eval_string</code>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-scopy"></a>
</p><dl>
<dt><u>Function:</u> <b>scopy</b><i> (<var>string</var>) </i>
<a name="IDX2757"></a>
</dt>
<dd><p>Returns a copy of <var>string</var> as a new string. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sdowncase"></a>
</p><dl>
<dt><u>Function:</u> <b>sdowncase</b><i> (<var>string</var>) </i>
<a name="IDX2758"></a>
</dt>
<dt><u>Function:</u> <b>sdowncase</b><i> (<var>string</var>, <var>start</var>) </i>
<a name="IDX2759"></a>
</dt>
<dt><u>Function:</u> <b>sdowncase</b><i> (<var>string</var>, <var>start</var>, <var>end</var>) </i>
<a name="IDX2760"></a>
</dt>
<dd><p>Like <code>supcase</code>, but uppercase characters are converted to lowercase. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sequal"></a>
</p><dl>
<dt><u>Function:</u> <b>sequal</b><i> (<var>string_1</var>, <var>string_2</var>) </i>
<a name="IDX2761"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>string_1</var> and <var>string_2</var> are the same length and contain the same characters. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sequalignore"></a>
</p><dl>
<dt><u>Function:</u> <b>sequalignore</b><i> (<var>string_1</var>, <var>string_2</var>)</i>
<a name="IDX2762"></a>
</dt>
<dd><p>Like <code>sequal</code> but ignores case. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sexplode"></a>
</p><dl>
<dt><u>Function:</u> <b>sexplode</b><i> (<var>string</var>)</i>
<a name="IDX2763"></a>
</dt>
<dd><p><code>sexplode</code> is an alias for function <code>charlist</code>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-simplode"></a>
</p><dl>
<dt><u>Function:</u> <b>simplode</b><i> (<var>list</var>)  </i>
<a name="IDX2764"></a>
</dt>
<dt><u>Function:</u> <b>simplode</b><i> (<var>list</var>, <var>delim</var>)  </i>
<a name="IDX2765"></a>
</dt>
<dd><p><code>simplode</code> takes a list of expressions and concatenates them into a string.
If no delimiter <var>delim</var> is specified, <code>simplode</code> uses no delimiter.
<var>delim</var> can be any string.
</p>
<pre class="example">(%i1) simplode([&quot;xx[&quot;,3,&quot;]:&quot;,expand((x+y)^3)]);
(%o1)             xx[3]:y^3+3*x*y^2+3*x^2*y+x^3
(%i2) simplode( sexplode(&quot;stars&quot;),&quot; * &quot; );
(%o2)                   s * t * a * r * s
(%i3) simplode( [&quot;One&quot;,&quot;more&quot;,&quot;coffee.&quot;],&quot; &quot; );
(%o3)                   One more coffee.
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sinsert"></a>
</p><dl>
<dt><u>Function:</u> <b>sinsert</b><i> (<var>seq</var>, <var>string</var>, <var>pos</var>)  </i>
<a name="IDX2766"></a>
</dt>
<dd><p>Returns a string that is a concatenation of <code>substring (<var>string</var>, 1, <var>pos</var> - 1)</code>,
the string <var>seq</var> and <code>substring (<var>string</var>, <var>pos</var>)</code>.
Note that the first character in <var>string</var> is in position 1.
</p>
<pre class="example">(%i1) s: &quot;A submarine.&quot;$
(%i2) concat( substring(s,1,3),&quot;yellow &quot;,substring(s,3) );
(%o2)                  A yellow submarine.
(%i3) sinsert(&quot;hollow &quot;,s,3);
(%o3)                  A hollow submarine.
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sinvertcase"></a>
</p><dl>
<dt><u>Function:</u> <b>sinvertcase</b><i> (<var>string</var>)  </i>
<a name="IDX2767"></a>
</dt>
<dt><u>Function:</u> <b>sinvertcase</b><i> (<var>string</var>, <var>start</var>)  </i>
<a name="IDX2768"></a>
</dt>
<dt><u>Function:</u> <b>sinvertcase</b><i> (<var>string</var>, <var>start</var>, <var>end</var>)  </i>
<a name="IDX2769"></a>
</dt>
<dd><p>Returns <var>string</var> except that each character from position <var>start</var> to <var>end</var> is inverted.
If <var>end</var> is not given,
all characters from <var>start</var> to the end of <var>string</var> are replaced.
</p>
<pre class="example">(%i1) sinvertcase(&quot;sInvertCase&quot;);
(%o1)                      SiNVERTcASE
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-slength"></a>
</p><dl>
<dt><u>Function:</u> <b>slength</b><i> (<var>string</var>) </i>
<a name="IDX2770"></a>
</dt>
<dd><p>Returns the number of characters in <var>string</var>. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-smake"></a>
</p><dl>
<dt><u>Function:</u> <b>smake</b><i> (<var>num</var>, <var>char</var>) </i>
<a name="IDX2771"></a>
</dt>
<dd><p>Returns a new string with a number of <var>num</var> characters <var>char</var>. 
</p>
<pre class="example">(%i1) smake(3,&quot;w&quot;);
(%o1)                          www
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-smismatch"></a>
</p><dl>
<dt><u>Function:</u> <b>smismatch</b><i> (<var>string_1</var>, <var>string_2</var>) </i>
<a name="IDX2772"></a>
</dt>
<dt><u>Function:</u> <b>smismatch</b><i> (<var>string_1</var>, <var>string_2</var>, <var>test</var>) </i>
<a name="IDX2773"></a>
</dt>
<dd><p>Returns the position of the first character of <var>string_1</var> at which <var>string_1</var> and <var>string_2</var> differ or <code>false</code>.
Default test function for matching is <code>sequal</code>.
If <code>smismatch</code> should ignore case, use <code>sequalignore</code> as test.
</p>
<pre class="example">(%i1) smismatch(&quot;seven&quot;,&quot;seventh&quot;);
(%o1)                           6
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-split"></a>
</p><dl>
<dt><u>Function:</u> <b>split</b><i> (<var>string</var>)  </i>
<a name="IDX2774"></a>
</dt>
<dt><u>Function:</u> <b>split</b><i> (<var>string</var>, <var>delim</var>)  </i>
<a name="IDX2775"></a>
</dt>
<dt><u>Function:</u> <b>split</b><i> (<var>string</var>, <var>delim</var>, <var>multiple</var>)  </i>
<a name="IDX2776"></a>
</dt>
<dd><p>Returns the list of all tokens in <var>string</var>.
Each token is an unparsed string.
<code>split</code> uses <var>delim</var> as delimiter.
If <var>delim</var> is not given, the space character is the default delimiter.
<var>multiple</var> is a boolean variable with <code>true</code> by default.
Multiple delimiters are read as one.
This is useful if tabs are saved as multiple space characters.
If <var>multiple</var> is set to <code>false</code>, each delimiter is noted.
</p>
<pre class="example">(%i1) split(&quot;1.2   2.3   3.4   4.5&quot;);
(%o1)                 [1.2, 2.3, 3.4, 4.5]
(%i2) split(&quot;first;;third;fourth&quot;,&quot;;&quot;,false);
(%o2)               [first, , third, fourth]
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sposition"></a>
</p><dl>
<dt><u>Function:</u> <b>sposition</b><i> (<var>char</var>, <var>string</var>) </i>
<a name="IDX2777"></a>
</dt>
<dd><p>Returns the position of the first character in <var>string</var> which matches <var>char</var>.
The first character in <var>string</var> is in position 1.
For matching characters ignoring case see <code>ssearch</code>.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sremove"></a>
</p><dl>
<dt><u>Function:</u> <b>sremove</b><i> (<var>seq</var>, <var>string</var>)  </i>
<a name="IDX2778"></a>
</dt>
<dt><u>Function:</u> <b>sremove</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>)  </i>
<a name="IDX2779"></a>
</dt>
<dt><u>Function:</u> <b>sremove</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>, <var>start</var>)  </i>
<a name="IDX2780"></a>
</dt>
<dt><u>Function:</u> <b>sremove</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>, <var>start</var>, <var>end</var>)  </i>
<a name="IDX2781"></a>
</dt>
<dd><p>Returns a string like <var>string</var> but without all substrings matching <var>seq</var>.
Default test function for matching is <code>sequal</code>.
If <code>sremove</code> should ignore case while searching for <var>seq</var>, use <code>sequalignore</code> as test.
Use <var>start</var> and <var>end</var> to limit searching.
Note that the first character in <var>string</var> is in position 1.
</p>
<pre class="example">(%i1) sremove(&quot;n't&quot;,&quot;I don't like coffee.&quot;);
(%o1)                   I do like coffee.
(%i2) sremove (&quot;DO &quot;,%,'sequalignore);
(%o2)                    I like coffee.
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sremovefirst"></a>
</p><dl>
<dt><u>Function:</u> <b>sremovefirst</b><i> (<var>seq</var>, <var>string</var>)  </i>
<a name="IDX2782"></a>
</dt>
<dt><u>Function:</u> <b>sremovefirst</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>)  </i>
<a name="IDX2783"></a>
</dt>
<dt><u>Function:</u> <b>sremovefirst</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>, <var>start</var>)  </i>
<a name="IDX2784"></a>
</dt>
<dt><u>Function:</u> <b>sremovefirst</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>, <var>start</var>, <var>end</var>)  </i>
<a name="IDX2785"></a>
</dt>
<dd><p>Like <code>sremove</code> except that only the first substring that matches <code>seq</code> is removed. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-sreverse"></a>
</p><dl>
<dt><u>Function:</u> <b>sreverse</b><i> (<var>string</var>) </i>
<a name="IDX2786"></a>
</dt>
<dd><p>Returns a string with all the characters of <var>string</var> in reverse order. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-ssearch"></a>
</p><dl>
<dt><u>Function:</u> <b>ssearch</b><i> (<var>seq</var>, <var>string</var>)  </i>
<a name="IDX2787"></a>
</dt>
<dt><u>Function:</u> <b>ssearch</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>)  </i>
<a name="IDX2788"></a>
</dt>
<dt><u>Function:</u> <b>ssearch</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>, <var>start</var>)  </i>
<a name="IDX2789"></a>
</dt>
<dt><u>Function:</u> <b>ssearch</b><i> (<var>seq</var>, <var>string</var>, <var>test</var>, <var>start</var>, <var>end</var>)</i>
<a name="IDX2790"></a>
</dt>
<dd><p>Returns the position of the first substring of <var>string</var> that matches the string <var>seq</var>.
Default test function for matching is <code>sequal</code>.
If <code>ssearch</code> should ignore case, use <code>sequalignore</code> as test.
Use <var>start</var> and <var>end</var> to limit searching.
Note that the first character in <var>string</var> is in position 1.
</p>
<pre class="example">(%i1) ssearch(&quot;~s&quot;,&quot;~{~S ~}~%&quot;,'sequalignore);
(%o1)                                  4
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-ssort"></a>
</p><dl>
<dt><u>Function:</u> <b>ssort</b><i> (<var>string</var>) </i>
<a name="IDX2791"></a>
</dt>
<dt><u>Function:</u> <b>ssort</b><i> (<var>string</var>, <var>test</var>) </i>
<a name="IDX2792"></a>
</dt>
<dd><p>Returns a string that contains all characters from <var>string</var> in an order such there are no two successive characters <var>c</var> and <var>d</var> such that <code>test (<var>c</var>, <var>d</var>)</code> is <code>false</code> and <code>test (<var>d</var>, <var>c</var>)</code> is <code>true</code>.
Default test function for sorting is <var>clessp</var>.
The set of test functions is <code>{clessp, clesspignore, cgreaterp, cgreaterpignore, cequal, cequalignore}</code>.
</p>
<pre class="example">(%i1) ssort(&quot;I don't like Mondays.&quot;);
(%o1)                    '.IMaddeiklnnoosty
(%i2) ssort(&quot;I don't like Mondays.&quot;,'cgreaterpignore);
(%o2)                 ytsoonnMlkIiedda.'   
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-ssubst"></a>
</p><dl>
<dt><u>Function:</u> <b>ssubst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>) </i>
<a name="IDX2793"></a>
</dt>
<dt><u>Function:</u> <b>ssubst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>, <var>test</var>) </i>
<a name="IDX2794"></a>
</dt>
<dt><u>Function:</u> <b>ssubst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>, <var>test</var>, <var>start</var>) </i>
<a name="IDX2795"></a>
</dt>
<dt><u>Function:</u> <b>ssubst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>, <var>test</var>, <var>start</var>, <var>end</var>) </i>
<a name="IDX2796"></a>
</dt>
<dd><p>Returns a string like <var>string</var> except that all substrings matching <var>old</var> are replaced by <var>new</var>.
<var>old</var> and <var>new</var> need not to be of the same length.
Default test function for matching is <code>sequal</code>.
If <code>ssubst</code> should ignore case while searching for old, use <code>sequalignore</code> as test.
Use <var>start</var> and <var>end</var> to limit searching.
Note that the first character in <var>string</var> is in position 1.
</p>
<pre class="example">(%i1) ssubst(&quot;like&quot;,&quot;hate&quot;,&quot;I hate Thai food. I hate green tea.&quot;);
(%o1)          I like Thai food. I like green tea.
(%i2) ssubst(&quot;Indian&quot;,&quot;thai&quot;,%,'sequalignore,8,12);
(%o2)         I like Indian food. I like green tea.
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-ssubstfirst"></a>
</p><dl>
<dt><u>Function:</u> <b>ssubstfirst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>) </i>
<a name="IDX2797"></a>
</dt>
<dt><u>Function:</u> <b>ssubstfirst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>, <var>test</var>) </i>
<a name="IDX2798"></a>
</dt>
<dt><u>Function:</u> <b>ssubstfirst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>, <var>test</var>, <var>start</var>) </i>
<a name="IDX2799"></a>
</dt>
<dt><u>Function:</u> <b>ssubstfirst</b><i> (<var>new</var>, <var>old</var>, <var>string</var>, <var>test</var>, <var>start</var>, <var>end</var>) </i>
<a name="IDX2800"></a>
</dt>
<dd><p>Like <code>subst</code> except that only the first substring that matches <var>old</var> is replaced. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-strim"></a>
</p><dl>
<dt><u>Function:</u> <b>strim</b><i> (<var>seq</var>,<var>string</var>) </i>
<a name="IDX2801"></a>
</dt>
<dd><p>Returns a string like <var>string</var>,
but with all characters that appear in <var>seq</var> removed from both ends. 
</p>
<pre class="example">(%i1) &quot;/* comment */&quot;$
(%i2) strim(&quot; /*&quot;,%);
(%o2)                        comment
(%i3) slength(%);
(%o3)                           7
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-striml"></a>
</p><dl>
<dt><u>Function:</u> <b>striml</b><i> (<var>seq</var>, <var>string</var>) </i>
<a name="IDX2802"></a>
</dt>
<dd><p>Like <code>strim</code> except that only the left end of <var>string</var> is trimmed. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-strimr"></a>
</p><dl>
<dt><u>Function:</u> <b>strimr</b><i> (<var>seq</var>, <var>string</var>) </i>
<a name="IDX2803"></a>
</dt>
<dd><p>Like <code>strim</code> except that only the right end of string is trimmed. 
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-stringp"></a>
</p><dl>
<dt><u>Function:</u> <b>stringp</b><i> (<var>obj</var>) </i>
<a name="IDX2804"></a>
</dt>
<dd><p>Returns <code>true</code> if <var>obj</var> is a string.
See introduction for example.
</p>
<div class=categorybox>
&middot;
<p>@ref{Category: Predicate functions} &middot;
@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-substring"></a>
</p><dl>
<dt><u>Function:</u> <b>substring</b><i> (<var>string</var>, <var>start</var>)</i>
<a name="IDX2805"></a>
</dt>
<dt><u>Function:</u> <b>substring</b><i> (<var>string</var>, <var>start</var>, <var>end</var>) </i>
<a name="IDX2806"></a>
</dt>
<dd><p>Returns the substring of <var>string</var> beginning at position <var>start</var> and ending at position <var>end</var>.
The character at position <var>end</var> is not included.
If <var>end</var> is not given, the substring contains the rest of the string.
Note that the first character in <var>string</var> is in position 1.
</p>
<pre class="example">(%i1) substring(&quot;substring&quot;,4);
(%o1)                        string
(%i2) substring(%,4,6);
(%o2)                          in
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-supcase"></a>
</p><dl>
<dt><u>Function:</u> <b>supcase</b><i> (<var>string</var>) </i>
<a name="IDX2807"></a>
</dt>
<dt><u>Function:</u> <b>supcase</b><i> (<var>string</var>, <var>start</var>) </i>
<a name="IDX2808"></a>
</dt>
<dt><u>Function:</u> <b>supcase</b><i> (<var>string</var>, <var>start</var>, <var>end</var>) </i>
<a name="IDX2809"></a>
</dt>
<dd><p>Returns <var>string</var> except that lowercase characters from position <var>start</var> to <var>end</var> are replaced by the corresponding uppercase ones.
If <var>end</var> is not given,
all lowercase characters from <var>start</var> to the end of <var>string</var> are replaced.
</p>
<pre class="example">(%i1) supcase(&quot;english&quot;,1,2);
(%o1)                        English
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-tokens"></a>
</p><dl>
<dt><u>Function:</u> <b>tokens</b><i> (<var>string</var>) </i>
<a name="IDX2810"></a>
</dt>
<dt><u>Function:</u> <b>tokens</b><i> (<var>string</var>, <var>test</var>) </i>
<a name="IDX2811"></a>
</dt>
<dd><p>Returns a list of tokens, which have been extracted from <var>string</var>.
The tokens are substrings whose characters satisfy a certain test function.
If test is not given, <var>constituent</var> is used as the default test.
<code>{constituent, alphacharp, digitcharp, lowercasep, uppercasep, charp, characterp, alphanumericp}</code> is the set of test functions. 
(The Lisp-version of <code>tokens</code> is written by Paul Graham. ANSI Common Lisp, 1996, page 67.)
</p>
<pre class="example">(%i1) tokens(&quot;24 October 2005&quot;);
(%o1)                  [24, October, 2005]
(%i2) tokens(&quot;05-10-24&quot;,'digitcharp);
(%o2)                     [05, 10, 24]
(%i3) map(parse_string,%);
(%o3)                      [5, 10, 24]
</pre>
<div class=categorybox>
&middot;
<p>@ref{Category: Package stringproc}
</div>
</p>
</dd></dl>

<p><a name="Item_003a-to_005fpoly_005fsolve"></a>
</p><hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC361" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="maxima_78.html#SEC366" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="maxima_82.html#SEC380" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
 <font size="-1">
  This document was generated by <em>root</em> on <em>January, 10 2014</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>.
 </font>
 <br>

</p>
</body>
</html>
maxima-doc 5.32.1-1 / usr / share / doc / maxima-doc / html / maxima_77.html
