Mercurial > octave-nkf

comparison scripts/java/javamem.m @ 20195:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents 0e1f5a750d00
children aa36fb998a4d
comparison
equal deleted inserted replaced
20194:597991b19e40 20195:03b9d17a2d95
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} javamem () 20 ## @deftypefn {Function File} {} javamem ()
21 ## @deftypefnx {Function File} {@var{jmem} =} javamem () 21 ## @deftypefnx {Function File} {@var{jmem} =} javamem ()
22 ## Show the current memory usage of the Java virtual machine (JVM) 22 ## Show the current memory usage of the Java virtual machine (JVM) and run the
23 ## and run the garbage collector. 23 ## garbage collector.
24 ## 24 ##
25 ## When no return argument is given the info is printed to the screen. 25 ## When no return argument is given the info is printed to the screen.
26 ## Otherwise, the output cell array @var{jmem} contains Maximum, Total, 26 ## Otherwise, the output cell array @var{jmem} contains Maximum, Total, and
27 ## and Free memory (in bytes). 27 ## Free memory (in bytes).
28 ## 28 ##
29 ## All Java-based routines are run in the JVM's shared memory pool, 29 ## All Java-based routines are run in the JVM's shared memory pool, a
30 ## a dedicated and separate part of memory claimed by the JVM from 30 ## dedicated and separate part of memory claimed by the JVM from your
31 ## your computer's total memory (which comprises physical RAM and 31 ## computer's total memory (which comprises physical RAM and virtual memory /
32 ## virtual memory / swap space on hard disk). 32 ## swap space on hard disk).
33 ## 33 ##
34 ## The maximum allowable memory usage can be configured using the file 34 ## The maximum allowable memory usage can be configured using the file
35 ## @file{java.opts}. The directory where this file resides is 35 ## @file{java.opts}. The directory where this file resides is determined by
36 ## determined by the environment variable @w{@env{OCTAVE_JAVA_DIR}}. 36 ## the environment variable @w{@env{OCTAVE_JAVA_DIR}}. If unset, the directory
37 ## If unset, the directory where @file{javaaddpath.m} resides is used instead 37 ## where @file{javaaddpath.m} resides is used instead (typically
38 ## (typically
39 ## @file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/}). 38 ## @file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/}).
40 ## 39 ##
41 ## @file{java.opts} is a plain text file with one option per line. The 40 ## @file{java.opts} is a plain text file with one option per line. The default
42 ## default initial memory size and default maximum memory size (which 41 ## initial memory size and default maximum memory size (which are both system
43 ## are both system dependent) can be overridden like so: 42 ## dependent) can be overridden like so:
44 ## 43 ##
45 ## @nospell{-Xms64m} 44 ## @nospell{-Xms64m}
46 ## 45 ##
47 ## @nospell{-Xmx512m} 46 ## @nospell{-Xmx512m}
48 ## 47 ##
49 ## (in megabytes in this example). 48 ## (in megabytes in this example).
50 ## You can adapt these values to your own requirements if your system 49 ## You can adapt these values to your own requirements if your system has
51 ## has limited available physical memory or if you get Java memory 50 ## limited available physical memory or if you get Java memory errors.
52 ## errors.
53 ## 51 ##
54 ## "Total memory" is what the operating system has currently assigned 52 ## @qcode{"Total memory"} is what the operating system has currently assigned
55 ## to the JVM and depends on actual and active memory usage. 53 ## to the JVM and depends on actual and active memory usage.
56 ## "Free memory" is self-explanatory. During operation of Java-based 54 ## @qcode{"Free memory"} is self-explanatory. During operation of Java-based
57 ## Octave functions the amount of Total and Free memory will vary, 55 ## Octave functions the amount of Total and Free memory will vary, due to
58 ## due to Java's own cleaning up and your operating system's memory 56 ## Java's own cleaning up and your operating system's memory management.
59 ## management.
60 ## @end deftypefn 57 ## @end deftypefn
61 58
62 ## Author: Philip Nienhuis 59 ## Author: Philip Nienhuis
63 ## Created: 2010-03-25 60 ## Created: 2010-03-25
64 ## Updates: 61 ## Updates: