octave_packages/benchmark-1.1.1/doc-cache

   1 # Created by Octave 3.6.1, Sun Apr 01 21:17:46 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 11
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 14
  10 benchmark_dtmm
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 679
  17  function benchmark_dtmm (m, n, nvec)
  18  description:
  19  Dense transposed matrix-matrix and matrix-vector multiplication benchmark.
  20  This is to test the "compound operators" feature introduced in Octave.
  21
  22  arguments:
  23  m = row dimension of matrices
  24  n = col dimension of matrices
  25  nvec = number of vector op repeats
  26
  27  results:
  28  time_tmm = Time for A'*B (A,B m-by-n matrices)
  29  time_smm = Time for A'*A
  30  time_mtm = Time for A*B' (A,B n-by-m matrices)
  31  time_msm = Time for A*A'
  32  time_tmv = Time for A'*v nvec-times (A m-by-n matrix)
  33  ratio_tmv = Ratio to precomputed transpose time
  34  time_mtv = Time for v*A' nvec-times (A m-by-n matrix)
  35  ratio_mtv = Ratio to precomputed transpose time
  36
  37
  38
  39
  40 # name: <cell-element>
  41 # type: sq_string
  42 # elements: 1
  43 # length: 80
  44  function benchmark_dtmm (m, n, nvec)
  45  description:
  46  Dense transposed matrix-mat
  47
  48
  49
  50 # name: <cell-element>
  51 # type: sq_string
  52 # elements: 1
  53 # length: 15
  54 benchmark_index
  55
  56
  57 # name: <cell-element>
  58 # type: sq_string
  59 # elements: 1
  60 # length: 608
  61  function benchmark_index (n, rep)
  62  description:
  63  Test speed of array indexing.
  64
  65  arguments:
  66  n = array size
  67  rep = number of repeats
  68
  69  results:
  70  time_slice1 = time for a(i:j)
  71  time_slice1s = time for a(i:k:j)
  72  time_slice1v = time for a(idx)
  73  time_slice2c = time for a(:,i:j)
  74  time_slice2r = time for a(i:j,:)
  75  time_slice2cv = time for a(:,idx)
  76  time_slice2rv = time for a(idx,:)
  77  time_slicenc = time for a(:,:,i:j,k)
  78  time_slicend = time for a(:,:,k,i:j)
  79  time_slicens = time for a(i,j,k,:)
  80  time_spreadr = time for a(ones(1, k), :), a row vector
  81  time_spreadc = time for a(:, ones(1, k)), a column vector
  82
  83
  84
  85
  86 # name: <cell-element>
  87 # type: sq_string
  88 # elements: 1
  89 # length: 79
  90  function benchmark_index (n, rep)
  91  description:
  92  Test speed of array indexing.
  93
  94
  95
  96 # name: <cell-element>
  97 # type: sq_string
  98 # elements: 1
  99 # length: 17
 100 benchmark_intmath
 101
 102
 103 # name: <cell-element>
 104 # type: sq_string
 105 # elements: 1
 106 # length: 1763
 107  function benchmark_intmath (n, ratio)
 108  description:
 109  Test speed of integer math & conversions.
 110
 111  arguments:
 112  n = array size
 113  ratio = ratio of intmath for generating integers
 114
 115  results:
 116  time_uint8_conv = time to convert real vector to uint8
 117  time_uint8_add = time to add two uint8 vectors
 118  time_uint8_sub = time to subtract two uint8 vectors
 119  time_uint8_mul = time to multiply two uint8 vectors
 120  time_uint8_div = time to divide two uint8 vectors
 121  time_int8_conv = time to convert real vector to int8
 122  time_int8_add = time to add two int8 vectors
 123  time_int8_sub = time to subtract two int8 vectors
 124  time_int8_mul = time to multiply two int8 vectors
 125  time_int8_div = time to divide two int8 vectors
 126  time_uint16_conv = time to convert real vector to uint16
 127  time_uint16_add = time to add two uint16 vectors
 128  time_uint16_sub = time to subtract two uint16 vectors
 129  time_uint16_mul = time to multiply two uint16 vectors
 130  time_uint16_div = time to divide two uint16 vectors
 131  time_int16_conv = time to convert real vector to int16
 132  time_int16_add = time to add two int16 vectors
 133  time_int16_sub = time to subtract two int16 vectors
 134  time_int16_mul = time to multiply two int16 vectors
 135  time_int16_div = time to divide two int16 vectors
 136  time_uint32_conv = time to convert real vector to uint32
 137  time_uint32_add = time to add two uint32 vectors
 138  time_uint32_sub = time to subtract two uint32 vectors
 139  time_uint32_mul = time to multiply two uint32 vectors
 140  time_uint32_div = time to divide two uint32 vectors
 141  time_int32_conv = time to convert real vector to int32
 142  time_int32_add = time to add two int32 vectors
 143  time_int32_sub = time to subtract two int32 vectors
 144  time_int32_mul = time to multiply two int32 vectors
 145  time_int32_div = time to divide two int32 vectors
 146
 147
 148
 149
 150 # name: <cell-element>
 151 # type: sq_string
 152 # elements: 1
 153 # length: 80
 154  function benchmark_intmath (n, ratio)
 155  description:
 156  Test speed of integer math
 157
 158
 159
 160 # name: <cell-element>
 161 # type: sq_string
 162 # elements: 1
 163 # length: 17
 164 benchmark_permute
 165
 166
 167 # name: <cell-element>
 168 # type: sq_string
 169 # elements: 1
 170 # length: 340
 171  function benchmark_permute (n)
 172  description:
 173  Test speed of array permuting.
 174
 175  arguments:
 176  n = dimension size (n^5 is number of elements)
 177
 178  results:
 179
 180  time_21345 = time for [2,1,3,4,5] permutation
 181  time_13425 = time for [1,3,4,2,5] permutation
 182  time_34125 = time for [3,4,1,2,5] permutation
 183  time_45123 = time for [4,5,1,2,3] permutation
 184
 185
 186
 187
 188 # name: <cell-element>
 189 # type: sq_string
 190 # elements: 1
 191 # length: 77
 192  function benchmark_permute (n)
 193  description:
 194  Test speed of array permuting.
 195
 196
 197
 198 # name: <cell-element>
 199 # type: sq_string
 200 # elements: 1
 201 # length: 14
 202 benchmark_stmm
 203
 204
 205 # name: <cell-element>
 206 # type: sq_string
 207 # elements: 1
 208 # length: 460
 209  function benchmark_stmm (n, nvec)
 210  description:
 211  Sparse transposed matrix-vector multiplication benchmark.
 212  This is to test the "compound operators" feature introduced in Octave.
 213
 214  arguments:
 215  n = dimension of matrix
 216  nvec = number of vector op repeats
 217
 218  results:
 219  time_tmm = Time for A'*B (B n^2-by-nvec matrix)
 220  time_tmv = Time for A'*v nvec-times (v vector)
 221  time_mtm = Time for B*A' (B nvec-by-n^2 matrix)
 222  time_mtv = Time for v*A' nvec-times (v vector)
 223
 224
 225
 226
 227 # name: <cell-element>
 228 # type: sq_string
 229 # elements: 1
 230 # length: 80
 231  function benchmark_stmm (n, nvec)
 232  description:
 233  Sparse transposed matrix-vecto
 234
 235
 236
 237 # name: <cell-element>
 238 # type: sq_string
 239 # elements: 1
 240 # length: 17
 241 benchutil_average
 242
 243
 244 # name: <cell-element>
 245 # type: sq_string
 246 # elements: 1
 247 # length: 136
 248  function results = benchutil_average (benchmark, nruns, arg1, arg2, ...)
 249  Average the benchmark results over a certain number of runs.
 250
 251
 252
 253 # name: <cell-element>
 254 # type: sq_string
 255 # elements: 1
 256 # length: 70
 257  function results = benchutil_average (benchmark, nruns, arg1, arg2, .
 258
 259
 260
 261 # name: <cell-element>
 262 # type: sq_string
 263 # elements: 1
 264 # length: 21
 265 benchutil_default_arg
 266
 267
 268 # name: <cell-element>
 269 # type: sq_string
 270 # elements: 1
 271 # length: 181
 272  benchmark_default_arg (name, value)
 273  set argument to a default value. This function is provided for
 274  compatibility with Matlab, which misses Octave's default arguments
 275  feature.
 276
 277
 278
 279
 280 # name: <cell-element>
 281 # type: sq_string
 282 # elements: 1
 283 # length: 70
 284  benchmark_default_arg (name, value)
 285  set argument to a default value.
 286
 287
 288
 289 # name: <cell-element>
 290 # type: sq_string
 291 # elements: 1
 292 # length: 20
 293 benchutil_initialize
 294
 295
 296 # name: <cell-element>
 297 # type: sq_string
 298 # elements: 1
 299 # length: 126
 300  function benchutil_initialize (mfname)
 301  initializes a benchmark. The argument passed must be the filename of the
 302  function.
 303
 304
 305
 306
 307 # name: <cell-element>
 308 # type: sq_string
 309 # elements: 1
 310 # length: 65
 311  function benchutil_initialize (mfname)
 312  initializes a benchmark.
 313
 314
 315
 316 # name: <cell-element>
 317 # type: sq_string
 318 # elements: 1
 319 # length: 19
 320 benchutil_is_octave
 321
 322
 323 # name: <cell-element>
 324 # type: sq_string
 325 # elements: 1
 326 # length: 105
 327  function benchutil_is_octave ()
 328  returns true if this is Octave. If not, we're probably run on Matlab.
 329
 330
 331
 332
 333 # name: <cell-element>
 334 # type: sq_string
 335 # elements: 1
 336 # length: 65
 337  function benchutil_is_octave ()
 338  returns true if this is Octave.
 339
 340
 341
 342 # name: <cell-element>
 343 # type: sq_string
 344 # elements: 1
 345 # length: 20
 346 benchutil_parse_desc
 347
 348
 349 # name: <cell-element>
 350 # type: sq_string
 351 # elements: 1
 352 # length: 133
 353  function [bench_desc, arg_desc, result_desc] = benchutil_parse_desc (mpath)
 354  parse the inline comment description from a benchmark
 355
 356
 357
 358
 359 # name: <cell-element>
 360 # type: sq_string
 361 # elements: 1
 362 # length: 80
 363  function [bench_desc, arg_desc, result_desc] = benchutil_parse_desc (mpath)
 364  pa
 365
 366
 367
 368 # name: <cell-element>
 369 # type: sq_string
 370 # elements: 1
 371 # length: 17
 372 benchutil_verbose
 373
 374
 375 # name: <cell-element>
 376 # type: sq_string
 377 # elements: 1
 378 # length: 97
 379  function OLD_FLAG = benchutil_verbose (NEW_FLAG)
 380  sets or queries the benchmark verbosity flag
 381
 382
 383
 384
 385 # name: <cell-element>
 386 # type: sq_string
 387 # elements: 1
 388 # length: 80
 389  function OLD_FLAG = benchutil_verbose (NEW_FLAG)
 390  sets or queries the benchmark
 391
 392
 393
 394
 395