diff doc/interpreter/vectorize.txi @ 16941:e6ddaa65a777

Add new function jit_startcnt to control JIT acceleration. * NEWS: Announce new function. * doc/interpreter/vectorize.txi: Add verbiage to manual about function. * libinterp/corefcn/pt-jit.cc(Fjit_startcnt): New function which manages static variable Vjit_startcnt. Variable is threshold above which JIT acceleration takes place. * libinterp/corefcn/pt-jit.cc(Fjit_enable, Fdebug_jit): Update seealso links in docstring.
author Rik <rik@octave.org>
date Tue, 09 Jul 2013 17:37:26 -0700
parents 48f5b993b819
children e7a059a9a644
line wrap: on
line diff
--- a/doc/interpreter/vectorize.txi	Tue Jul 09 16:47:57 2013 -0700
+++ b/doc/interpreter/vectorize.txi	Tue Jul 09 17:37:26 2013 -0700
@@ -519,8 +519,8 @@
 statements into another language, compiling the new code segment into an
 executable, and then running the executable and collecting any results.  The
 process is not simple and there is a significant amount of work to perform for
-each step.  It can still make sense, however, if the loop counter is a
-large number.  Because Octave is an interpreted language every time through a
+each step.  It can still make sense, however, if the number of loop iterations
+is large.  Because Octave is an interpreted language every time through a
 loop Octave must parse the statements in the loop body before executing them.
 With a JIT compiler this is done just once when the body is translated to
 another language.
@@ -528,12 +528,16 @@
 The JIT compiler is a very new feature in Octave and not all valid Octave
 statements can currently be accelerated.  However, if no other technique
 is available it may be worth benchmarking the code with JIT enabled.  The
-function @code{jit_enable} is used to turn compilation on or off.  The function
-@code{debug_jit} is not likely to be of use to anyone not working directly on
-the implementation of the JIT compiler.
+function @code{jit_enable} is used to turn compilation on or off.  The
+function @code{jit_startcnt} sets the threshold for acceleration.  Loops
+with iteration counts above @code{jit_startcnt} will be accelerated.  The
+function @code{debug_jit} is not likely to be of use to anyone not working
+directly on the implementation of the JIT compiler.
 
 @DOCSTRING(jit_enable)
 
+@DOCSTRING(jit_startcnt)
+
 @DOCSTRING(debug_jit)
 
 @node Miscellaneous Techniques