Mercurial > octave

diff libinterp/corefcn/stream-euler.cc @ 27810:f2b89a2e20b6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
overhaul streamXXX.m series of functions. * stream-euler.cc (__streameuler3d__, __streameuler2d__): Use @code{} macro in docstring. * stream2.m, stream3.m, streamline.m, streamtube.m: Match names in documentation with variable names in code. Don't use double quotes around "options" input which is not a string input. Use numel() in preference to length(). Don't surround condition of case statement with parentheses. Use size_equal() function to simplify input validation. Avoid unnecessary use of logical(). Use two newlines after "endfunction" and start of %!demo blocks. Add BIST tests for input validation.
author Rik <rik@octave.org>
date Thu, 12 Dec 2019 14:50:17 -0800
parents d7dfab7045d9
children b442ec6dda5c
line wrap: on
line diff
--- a/libinterp/corefcn/stream-euler.cc	Thu Dec 12 20:35:09 2019 +0100
+++ b/libinterp/corefcn/stream-euler.cc	Thu Dec 12 14:50:17 2019 -0800
@@ -57,7 +57,7 @@
   double x, y;
 } Vector2;
 
-// The integer- and the fractional value from a point in C-Space.
+// The integer value and the fractional value from a point in C-Space.
 // Equivalent to the cell index the point is located in and the local
 // coordinates of the point in the cell.
 
@@ -503,10 +503,11 @@
 DEFUN (__streameuler2d__, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} __streameuler2d__ (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS})
-Calculates the streamline in a vector field [@var{U}, @var{V}] starting from a
-seed point at position [@var{ZETA}, @var{XI}].  The integrator used is
-Heun's Scheme.  The step size can be controlled by @var{H}.  The Jacobian
-matrix can be defined for each grid cell by [@var{TX}, @var{TY}].
+Calculates the streamline in a vector field @code{[@var{U}, @var{V}]} starting
+from a seed point at position @code{[@var{ZETA}, @var{XI}]}.  The integrator
+used is Heun's Scheme.  The step size can be controlled by @var{H}.  The
+Jacobian matrix can be defined for each grid cell by
+@code{[@var{TX}, @var{TY}]}.
 
 @seealso{streamline, stream2, stream3, __streameuler3d__}
 @end deftypefn */)
@@ -517,11 +518,11 @@
 DEFUN (__streameuler3d__, args, ,
        doc: /* -*- texinfo -*-
 @deftypefn {} {} __streameuler3d__ (@var{U}, @var{V}, @var{W}, @var{TX}, @var{TY}, @var{TZ}, @var{ZETA}, @var{XI}, @var{RHO}, @var{H}, @var{MAXNVERTS})
-Calculates the streamline in a vector field [@var{U}, @var{V}, @var{W}]
-starting from a seed point at position [@var{ZETA}, @var{XI}, @var{RHO}].  The
-integrator used is Heun's Scheme.  The step size can be controlled by @var{H}.
- The Jacobian matrix can be defined for each grid cell by [@var{TX}, @var{TY},
-@var{TZ}].
+Calculates the streamline in a vector field @code{[@var{U}, @var{V}, @var{W}]}
+starting from a seed point at position
+@code{[@var{ZETA}, @var{XI}, @var{RHO}]}.  The integrator used is Heun's
+Scheme.  The step size can be controlled by @var{H}.  The Jacobian matrix can
+be defined for each grid cell by @code{[@var{TX}, @var{TY}, @var{TZ}]}.
 
 @seealso{streamline, stream2, stream3, __streameuler2d__}
 @end deftypefn */)