Skip to content

Commit 1a8b433

Browse files
committed
Add sortreallocate documentation to the manual
1 parent 519e784 commit 1a8b433

File tree

3 files changed

+36
-0
lines changed

3 files changed

+36
-0
lines changed

doc/manual/prepro.tex

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1936,6 +1936,22 @@ \section{\#skipextrasymbols}
19361936
incorrect.
19371937

19381938
%--#] skipextrasymbols :
1939+
%--#[ sortreallocate :
1940+
1941+
\section{\#sortreallocate}
1942+
\label{presortreallocate}
1943+
1944+
\noindent Syntax:
1945+
1946+
\#sortreallocate\index{\#sortreallocate}
1947+
1948+
\noindent See also ``On sortreallocate;'' (\ref{substaon}).
1949+
1950+
\noindent Reallocates the small and large buffer (also on the worker threads)
1951+
at the end of the current module. In some cases this can significantly reduce
1952+
\FORM's memory usage as measured by ``resident set size''.
1953+
1954+
%--#] sortreallocate :
19391955
%--#[ switch :
19401956

19411957
\section{\#switch}

doc/manual/setup.tex

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,14 @@ \chapter{The setup}
439439
with 1/N times the size of the buffer of the master. This may get made a
440440
bit bigger when potential conflicts with MaxTermSize occur.
441441

442+
The (typically) largest buffers (the small and large buffers) may be reallocated
443+
at the end of a single module (see \#sortreallocate (\ref{presortreallocate})) or
444+
at the end of each module (see ``On sortreallocate;'' (\ref{substaon})). In some
445+
cases this can significantly reduce \FORM's memory usage as measured by
446+
``resident set size''. For programs which consist of a large number of very
447+
quickly-running modules, this can incur a noticable performance penalty if performed
448+
every module.
449+
442450
The default settings are
443451
\begin{center}
444452
\begin{tabular}{lrrr}

doc/manual/statements.tex

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3836,6 +3836,10 @@ \section{off}
38363836
\rightvitem{13cm}{Takes the writing of the statistics back from shorthand
38373837
mode to the regular statistics mode in which each statistics messages takes
38383838
three lines of text and one blank line.}
3839+
3840+
\leftvitem{3.5cm}{sortreallocate\index{off!sortreallocate}}
3841+
\rightvitem{13cm}{Turns off the reallocation of the small and large buffer
3842+
at the end of each module.}
38393843

38403844
\leftvitem{3.5cm}{threadloadbalancing\index{off!threadloadbalancing}}
38413845
\rightvitem{13cm}{\vspace{1.5ex}Disables the loadbalancing mechanism of
@@ -4001,6 +4005,14 @@ \section{on}
40014005
\leftvitem{3.5cm}{shortstats\index{on!shortstats}}
40024006
\rightvitem{13cm}{Same as `On shortstatistics'.}
40034007

4008+
\leftvitem{3.5cm}{sortreallocate\index{on!sortreallocate}}
4009+
\rightvitem{13cm}{Reallocate the small and large buffer (also on the worker
4010+
threads) at the end of every module. In some cases this can significantly reduce
4011+
\FORM's memory usage as measured by ``resident set size''. For programs which
4012+
consist of a large number of very quickly-running modules, this can incur a
4013+
noticable performance penalty. See also \#sortreallocate (\ref{presortreallocate})
4014+
for a single-module version of this feature.}
4015+
40044016
\leftvitem{3.5cm}{statistics\index{on!statistics}}
40054017
\rightvitem{13cm}{Turns the writing of runtime statistics on. This is the
40064018
default. It is possible to change this default with one of the setup

0 commit comments

Comments
 (0)