Mercurial > octave-nkf
diff scripts/java/javamem.m @ 15772:0f1a143e5002
Overhaul scripts/java directory to conform to Octave core.
Update docstrings. Use Octave coding conventions. Use default arguments
where possible. Match variable names in docstring to variable names in
function.
HG: Enter commit message. Lines beginning with 'HG:' are removed.
HG: Leave message empty to abort commit.
HG: --
HG: user: Rik <rik@octave.org>
HG: branch 'default'
* errordlg.m, helpdlg.m, inputdlg.m, javaArray.m, javaaddpath.m,
javaclasspath.m, javafields.m, javamem.m, javamethods.m, javarmpath.m,
listdlg.m, msgbox.m, questdlg.m, warndlg.m: Overhaul functions.
Update docstrings. Use Octave coding conventions. Use default arguments
where possible. Match variable names in docstring to variable names in
function.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 12 Dec 2012 13:48:47 -0800 |
parents | 54e8c2527a9e |
children | 921912c92102 |
line wrap: on
line diff
--- a/scripts/java/javamem.m Wed Dec 12 13:33:37 2012 -0800 +++ b/scripts/java/javamem.m Wed Dec 12 13:48:47 2012 -0800 @@ -17,13 +17,13 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} javamem () -## @deftypefnx {Function File} [@var{jmem}] = javamem () -## Show current memory status of the Java virtual machine (JVM) -## and run garbage collector. +## @deftypefn {Function File} {} javamem () +## @deftypefnx {Function File} {@var{jmem} =} javamem () +## Show the current memory usage of the Java virtual machine (JVM) +## and run the garbage collector. ## -## When no return argument is given the info is echoed to the screen. -## Otherwise, output cell array @var{jmem} contains Maximum, Total, +## When no return argument is given the info is printed to the screen. +## Otherwise, the output cell array @var{jmem} contains Maximum, Total, ## and Free memory (in bytes). ## ## All Java-based routines are run in the JVM's shared memory pool, @@ -31,25 +31,29 @@ ## your computer's total memory (which comprises physical RAM and ## virtual memory / swap space on hard disk). ## -## The maximum available memory can be set using the file java.opts +## The maximum allowable memory usage can be set using the file java.opts ## (in the same subdirectory where javaaddpath.m lives, see -## "which javaaddpath". Usually that is: @* -## [/usr]/share/octave/packages/java-<version>. +## "which javaaddpath". Usually that is: +## +## @file{OCTAVE_HOME/share/octave/OCTAVE_VERSION/m/java/} ## -## java.opts is a plain text file, one option per line. The +## java.opts is a plain text file with one option per line. The ## default initial memory size and default maximum memory size (which -## are both system dependent) can be overridden like so: @* -## -Xms64m @* -## -Xmx512m @* +## are both system dependent) can be overridden like so: +## +## @nospell{-Xms64m} +## +## @nospell{-Xmx512m} +## ## (in megabytes in this example.) ## You can adapt these values to your own requirements if your system -## has limited available physical memory or when you get Java memory +## has limited available physical memory or if you get Java memory ## errors. ## ## "Total memory" is what the operating system has currently assigned ## to the JVM and depends on actual and active memory usage. -## "Free memory" is self-explanatory. During operation of Java-based -## octave functions the amounts of Total and Free memory will vary, +## "Free memory" is self-explanatory. During operation of Java-based +## Octave functions the amount of Total and Free memory will vary, ## due to Java's own cleaning up and your operating system's memory ## management. ## @end deftypefn @@ -61,28 +65,29 @@ ## 2010-08-25 Corrected text on java memory assignments ## 2010-09-05 Further overhauled help text -function j_mem = javamem () +function jmem = javamem () rt = java_invoke ("java.lang.Runtime", "getRuntime"); rt.gc; - jmem = cell (3, 1); - jmem{1} = rt.maxMemory ().doubleValue (); - jmem{2} = rt.totalMemory ().doubleValue (); - jmem{3} = rt.freeMemory ().doubleValue (); + jvmem = cell (3, 1); + jvmem{1} = rt.maxMemory ().doubleValue (); + jvmem{2} = rt.totalMemory ().doubleValue (); + jvmem{3} = rt.freeMemory ().doubleValue (); if (nargout == 0) printf ("\nJava virtual machine (JVM) memory info:\n"); printf ("Maximum available memory: %5d MiB;\n", - jmem{1} / 1024 / 1024); + jvmem{1} / 1024 / 1024); printf (" (...running garbage collector...)\n"); printf ("OK, current status:\n"); printf ("Total memory in virtual machine: %5d MiB;\n", - jmem{2} / 1024 / 1024); + jvmem{2} / 1024 / 1024); printf ("Free memory in virtual machine: %5d MiB;\n", - jmem{3} / 1024 / 1024); + jvmem{3} / 1024 / 1024); printf ("%d CPUs available.\n", rt.availableProcessors ()); else - j_mem = jmem; + jmem = jvmem; endif endfunction +