changelog shortlog tags changeset files revisions annotate raw

scripts/testfun/example.m

changeset 10289: 4b124317dc38
parent:eb63fbe60fab
author: John W. Eaton <jwe@octave.org>
date: Tue Feb 09 20:58:55 2010 -0500 (37 minutes ago)
permissions: -rw-r--r--
description: base_properties::set_children: account for hidden children 
     1## Copyright (C) 2000, 2006, 2007, 2009 Paul Kienzle

     2##

     3## This file is part of Octave.

     4##

     5## Octave is free software; you can redistribute it and/or modify it

     6## under the terms of the GNU General Public License as published by

     7## the Free Software Foundation; either version 3 of the License, or (at

     8## your option) any later version.

     9##

    10## Octave is distributed in the hope that it will be useful, but

    11## WITHOUT ANY WARRANTY; without even the implied warranty of

    12## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    13## General Public License for more details.

    14##

    15## You should have received a copy of the GNU General Public License

    16## along with Octave; see the file COPYING.  If not, see

    17## <http://www.gnu.org/licenses/>.

    18

    19## -*- texinfo -*-

    20## @deftypefn {Function File} {} example ('@var{name}',@var{n})

    21## @deftypefnx {Function File} {[@var{x}, @var{idx}] =} example ('@var{name}',@var{n})

    22##

    23##  Display the code for example @var{n} associated with the function 

    24## '@var{name}', but do not run it.  If @var{n} is not given, all examples 

    25## are displayed.

    26##

    27## Called with output arguments, the examples are returned in the form of

    28## a string @var{x}, with @var{idx} indicating the ending position of the 

    29## various examples.

    30##

    31## See @code{demo} for a complete explanation.

    32## @seealso{demo, test}

    33## @end deftypefn

    34

    35function [code_r, idx_r] = example (name, n)

    36

    37  if (nargin < 1 || nargin > 2)

    38    print_usage ();

    39  endif

    40  if (nargin < 2)

    41    n = 0;

    42  endif

    43

    44  [code, idx] = test (name, "grabdemo");

    45  if (nargout > 0)

    46    if (n > 0)

    47      if (n <= length (idx))

    48      	code_r = code(idx(n):idx(n+1)-1);

    49      	idx_r = [1, length(code_r)+1];

    50      else

    51	code_r = "";

    52	idx_r = [];

    53      endif

    54    else

    55      code_r = code;

    56      idx_r = idx;

    57    endif

    58  else

    59    if (n > 0)

    60      doidx = n;

    61    else

    62      doidx = 1:length(idx)-1;

    63    endif

    64    if (length (idx) == 0)

    65      warning ("example not available for %s", name);

    66    elseif (n >= length(idx))

    67      warning ("only %d examples available for %s", length(idx)-1, name);

    68      doidx = [];

    69    endif

    70

    71    for i = 1:length (doidx)

    72      block = code (idx(doidx(i)):idx(doidx(i)+1)-1);

    73      printf ("%s example %d:%s\n\n", name, doidx(i), block);

    74    endfor

    75  endif

    76

    77endfunction

    78

    79%!## warning: don't modify the demos without modifying the tests!

    80%!demo

    81%! example('example');

    82%!demo

    83%! t=0:0.01:2*pi; x=sin(t);

    84%! plot(t,x)

    85

    86%!assert (example('example',1), "\n example('example');");

    87%!test

    88%! [code, idx] = example('example');

    89%! assert (code, ... 

    90%!	   "\n example('example');\n t=0:0.01:2*pi; x=sin(t);\n plot(t,x)")

    91%! assert (idx, [1, 22, 59]);

    92

    93%!error example;

    94%!error example('example',3,5)