scilab/modules/string/help/en_US/strrev.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   4  * Copyright (C) INRIA -
   5  *
   6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
   7  *
   8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
   9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
  10  * This file was originally licensed under the terms of the CeCILL v2.1,
  11  * and continues to be available under such terms.
  12  * For more information, see the COPYING file which you should have received
  13  * along with this program.
  14  *
  15  -->
  16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
  17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:db="http://docbook.org/ns/docbook"
  18           xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="strrev">
  19     <refnamediv>
  20         <refname>strrev</refname>
  21         <refpurpose>
  22             Reverses the order of characters in the given texts
  23         </refpurpose>
  24     </refnamediv>
  25     <refsynopsisdiv>
  26         <title>Syntax</title>
  27         <synopsis>res = strrev(str1)</synopsis>
  28     </refsynopsisdiv>
  29     <refsection>
  30         <title>Arguments</title>
  31         <variablelist>
  32             <varlistentry>
  33                 <term>str1</term>
  34                 <listitem>
  35                     <para>
  36                         a character string or matrix of character strings.
  37                     </para>
  38                 </listitem>
  39             </varlistentry>
  40             <varlistentry>
  41                 <term>res</term>
  42                 <listitem>
  43                     <para>
  44                         a character string or matrix of character strings.
  45                     </para>
  46                 </listitem>
  47             </varlistentry>
  48         </variablelist>
  49     </refsection>
  50     <refsection>
  51         <title>Description</title>
  52         <para>
  53             <code>res = strrev(str1)</code> returns string reversed.
  54         </para>
  55     </refsection>
  56     <refsection>
  57         <title>Examples</title>
  58         <programlisting role="example"><![CDATA[
  59 rev = strrev('This is a simple string')
  60 strrev(rev)
  61 strrev(['This is a simple string','scilab'])
  62  ]]></programlisting>
  63     </refsection>
  64 </refentry>