octave_packages/strings-1.1.0/doc-cache

   1 # Created by Octave 3.6.1, Sat Mar 17 00:02:04 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 6
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 12
  10 base64decode
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 586
  17  -- Function File: RVAL = base64decode (CODE)
  18  -- Function File: RVAL = base64decode (CODE, AS_STRING)
  19      Convert a base64 CODE  (a string of printable characters according
  20      to RFC 2045) into the original ASCII data set of range 0-255. If
  21      option AS_STRING is passed, the return value is converted into a
  22      string.
  23
  24                     ##base64decode(base64encode('Hakuna Matata'),true)
  25                     base64decode('SGFrdW5hIE1hdGF0YQ==',true)
  26                     ##returns 'Hakuna Matata'
  27
  28      See: http://www.ietf.org/rfc/rfc2045.txt
  29
  30      See also: base64encode
  31
  32
  33
  34
  35
  36 # name: <cell-element>
  37 # type: sq_string
  38 # elements: 1
  39 # length: 80
  40 Convert a base64 CODE  (a string of printable characters according to
  41 RFC 2045)
  42
  43
  44
  45 # name: <cell-element>
  46 # type: sq_string
  47 # elements: 1
  48 # length: 12
  49 base64encode
  50
  51
  52 # name: <cell-element>
  53 # type: sq_string
  54 # elements: 1
  55 # length: 477
  56  -- Function File: Y = base64encode (X)
  57  -- Function File: Y = base64encode (X, DO_RESHAPE)
  58      Convert X into string of printable characters according to RFC
  59      2045.  The input may be a string or a matrix of integers in the
  60      range 0..255.  If want the output in the 1-row of strings format,
  61      pass the DO_RESHAPE argument as true.
  62
  63      Example:
  64           base64encode('Hakuna Matata',true)
  65           ##returns 'SGFrdW5hIE1hdGF0YQ=='
  66
  67      See also: base64decode
  68
  69
  70
  71
  72
  73 # name: <cell-element>
  74 # type: sq_string
  75 # elements: 1
  76 # length: 68
  77 Convert X into string of printable characters according to RFC 2045.
  78
  79
  80
  81 # name: <cell-element>
  82 # type: sq_string
  83 # elements: 1
  84 # length: 7
  85 cstrcmp
  86
  87
  88 # name: <cell-element>
  89 # type: sq_string
  90 # elements: 1
  91 # length: 845
  92  -- Function File: RVAL = cstrcmp (S1, S2)
  93      Compare strings S1 and S2 like the C function.
  94
  95      Aside the difference to the return values, this function API is
  96      exactly the same as Octave's `strcmp' and will accept cell arrays
  97      as well.
  98
  99      RVAL indicates the relationship between the strings:
 100         * A value of 0 indicates that both strings are equal;
 101
 102         * A value of +1 indicates that the first character that does
 103           not match has a greater value in S1 than in S2.
 104
 105         * A value of -1 indicates that the first character that does
 106           not match has a match has a smaller value in S1 than in S2.
 107
 108           cstrcmp("marry","marry")
 109                 =>  0
 110           cstrcmp("marry","marri")
 111                 => +1
 112           cstrcmp("marri","marry")
 113                 => -1
 114
 115      See also: strcmp, strcmpi
 116
 117
 118
 119
 120
 121 # name: <cell-element>
 122 # type: sq_string
 123 # elements: 1
 124 # length: 46
 125 Compare strings S1 and S2 like the C function.
 126
 127
 128
 129 # name: <cell-element>
 130 # type: sq_string
 131 # elements: 1
 132 # length: 12
 133 editdistance
 134
 135
 136 # name: <cell-element>
 137 # type: sq_string
 138 # elements: 1
 139 # length: 882
 140  -- Function File: [DIST,L] = editdistance (STRING1, STRING2, WEIGHTS)
 141      Compute the Levenshtein edit distance between the strings STRING1
 142      and STRING2. This operation is symmetrical.
 143
 144      The optional argument WEIGHTS specifies weights for the deletion,
 145      matched, and insertion operations; by default it is set to +1, 0,
 146      +1 respectively, so that a least editdistance means a closer match
 147      between the two strings. This function implements the Levenshtein
 148      edit distance as presented in Wikipedia article, accessed Nov
 149      2006. Also the levenshtein edit distance of a string with an empty
 150      string is defined to be its length.
 151
 152      The default return value is DIST the edit distance, and the other
 153      return value  L is the distance matrix.
 154
 155                    editdistance('marry','marie')
 156                    ##returns value +2 for the distance.
 157
 158
 159
 160
 161
 162 # name: <cell-element>
 163 # type: sq_string
 164 # elements: 1
 165 # length: 78
 166 Compute the Levenshtein edit distance between the strings STRING1 and
 167 STRING2.
 168
 169
 170
 171 # name: <cell-element>
 172 # type: sq_string
 173 # elements: 1
 174 # length: 7
 175 strjoin
 176
 177
 178 # name: <cell-element>
 179 # type: sq_string
 180 # elements: 1
 181 # length: 741
 182  -- Function File: RVAL = strjoin (PREFIXSTR, STRINGCELL)
 183  -- Function File: RVAL = strjoin (PREFIXSTR, VARARGS)
 184      Joins the strings in STRINGCELL with the PREFIXSTR like the
 185      list-join function in Python; the second version allows usage with
 186      variable number of arguments.  Note that, if using cell-array as a
 187      second argument, only 2 arguments are accepted.  Also note that,
 188      both the arguments are strings or containers of strings (cells).
 189
 190                     strjoin(' loves-> ','marie','amy','beth')
 191                     ##returns 'marie loves-> amy loves-> beth'
 192
 193                     strjoin('*',{'Octave','Scilab','Lush','Yorick'})
 194                     ##returns 'Octave*Scilab*Lush*Yorick'
 195
 196      See also: strcmp
 197
 198
 199
 200
 201
 202 # name: <cell-element>
 203 # type: sq_string
 204 # elements: 1
 205 # length: 80
 206 Joins the strings in STRINGCELL with the PREFIXSTR like the list-join
 207 function i
 208
 209
 210
 211 # name: <cell-element>
 212 # type: sq_string
 213 # elements: 1
 214 # length: 7
 215 strsort
 216
 217
 218 # name: <cell-element>
 219 # type: sq_string
 220 # elements: 1
 221 # length: 120
 222  -- Function File: [...] = strsort (...)
 223      Overloads the sort function to operate on strings.
 224
 225      See also: sort
 226
 227
 228
 229
 230
 231 # name: <cell-element>
 232 # type: sq_string
 233 # elements: 1
 234 # length: 50
 235 Overloads the sort function to operate on strings.
 236
 237
 238
 239
 240