Mercurial > octave

comparison libinterp/corefcn/stream-euler.cc @ 30888:32d2b6604a9f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Ensure documentation lists output argument when it exists for functions in libinterp/ For new users of Octave it is best to show explicit calling forms in the documentation and to show a return argument when it exists. * __ftp__.cc, __magick_read__.cc, __pchip_deriv__.cc, bitfcns.cc, bsxfun.cc, call-stack.cc, cellfun.cc, chol.cc, conv2.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, display.cc, dot.cc, error.cc, event-manager.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, getgrent.cc, getpwent.cc, getrusage.cc, graphics.cc, hash.cc, help.cc, input.cc, interpreter.cc, kron.cc, load-path.cc, mappers.cc, max.cc, nproc.cc, oct-hist.cc, pager.cc, pinv.cc, psi.cc, rand.cc, settings.cc, sighandlers.cc, stream-euler.cc, strfns.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, utils.cc, variables.cc, __fltk_uigetfile__.cc, audiodevinfo.cc, audioread.cc, fftw.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc, profiler.cc: Add return arguments to @deftypefn macros where they were missing. Attempt to use standard naming convention for return variables. Occasionally improved the docstring itself by re-wording or adding code examples.
author Rik <rik@octave.org>
date Mon, 04 Apr 2022 10:31:48 -0700
parents 796f54d4ddbf
children a3d8915b9f87
comparison
equal deleted inserted replaced
30887:4bab8d3fce79 30888:32d2b6604a9f
504 return octave_value (xyz); 504 return octave_value (xyz);
505 } 505 }
506 506
507 DEFUN (__streameuler2d__, args, , 507 DEFUN (__streameuler2d__, args, ,
508 doc: /* -*- texinfo -*- 508 doc: /* -*- texinfo -*-
509 @deftypefn {} {} __streameuler2d__ (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS}) 509 @deftypefn {} {@var{output} =} __streameuler2d__ (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS})
510 Calculates the streamline in a vector field @code{[@var{U}, @var{V}]} starting 510 Calculates the streamline in a vector field @code{[@var{U}, @var{V}]} starting
511 from a seed point at position @code{[@var{ZETA}, @var{XI}]}. The integrator 511 from a seed point at position @code{[@var{ZETA}, @var{XI}]}. The integrator
512 used is Heun's Scheme. The step size can be controlled by @var{H}. The 512 used is Heun's Scheme. The step size can be controlled by @var{H}. The
513 Jacobian matrix can be defined for each grid cell by 513 Jacobian matrix can be defined for each grid cell by
514 @code{[@var{TX}, @var{TY}]}. 514 @code{[@var{TX}, @var{TY}]}.
519 return streameuler2d_internal (args); 519 return streameuler2d_internal (args);
520 } 520 }
521 521
522 DEFUN (__streameuler3d__, args, , 522 DEFUN (__streameuler3d__, args, ,
523 doc: /* -*- texinfo -*- 523 doc: /* -*- texinfo -*-
524 @deftypefn {} {} __streameuler3d__ (@var{U}, @var{V}, @var{W}, @var{TX}, @var{TY}, @var{TZ}, @var{ZETA}, @var{XI}, @var{RHO}, @var{H}, @var{MAXNVERTS}) 524 @deftypefn {} {@var{output} =} __streameuler3d__ (@var{U}, @var{V}, @var{W}, @var{TX}, @var{TY}, @var{TZ}, @var{ZETA}, @var{XI}, @var{RHO}, @var{H}, @var{MAXNVERTS})
525 Calculates the streamline in a vector field @code{[@var{U}, @var{V}, @var{W}]} 525 Calculates the streamline in a vector field @code{[@var{U}, @var{V}, @var{W}]}
526 starting from a seed point at position 526 starting from a seed point at position
527 @code{[@var{ZETA}, @var{XI}, @var{RHO}]}. The integrator used is Heun's 527 @code{[@var{ZETA}, @var{XI}, @var{RHO}]}. The integrator used is Heun's
528 Scheme. The step size can be controlled by @var{H}. The Jacobian matrix can 528 Scheme. The step size can be controlled by @var{H}. The Jacobian matrix can
529 be defined for each grid cell by @code{[@var{TX}, @var{TY}, @var{TZ}]}. 529 be defined for each grid cell by @code{[@var{TX}, @var{TY}, @var{TZ}]}.