Detailed Listing of Octave Variables

Description

The function o_whos returns a detailed description of the variables defined in the current Octave session.

Usage

o_whos(..., options, rm.ans = FALSE)

Arguments

...
filtering patterns or extra arguments passed to o_who and o_whos. Only names matching any of the patterns are returned.
options
options passed to Octave function who. See section Octave Documentation.
rm.ans
a logical that indicates if the automatic Octave variable ans should be included in the result (FALSE) or removed (TRUE).

Octave Documentation for <em>whos</em>

 -- Command: whos
 -- Command: whos pattern ...
 -- Command: whos option pattern ...
 -- Command: S = whos ("pattern", ...)
     Provide detailed information on currently defined variables
     matching the given patterns.  Options and pattern syntax are the
     same as for the 'who' command.  Extended information about each
     variable is summarized in a table with the following default
     entries.

     Attr
          Attributes of the listed variable.  Possible attributes are:
          blank
               Variable in local scope

          'a'
               Automatic variable.  An automatic variable is one created
               by the interpreter, for example 'argn'.

          'c'
               Variable of complex type.

          'f'
               Formal parameter (function argument).

          'g'
               Variable with global scope.

          'p'
               Persistent variable.

     Name
          The name of the variable.

     Size
          The logical size of the variable.  A scalar is 1x1, a vector
          is 1xN or Nx1, a 2-D matrix is MxN.

     Bytes
          The amount of memory currently used to store the variable.

     Class
          The class of the variable.  Examples include double, single,
          char, uint16, cell, and struct.

     The table can be customized to display more or less information
     through the function 'whos_line_format'.

     If 'whos' is called as a function, return a struct array of defined
     variable names matching the given patterns.  Fields in the
     structure describing each variable are: name, size, bytes, class,
     global, sparse, complex, nesting, persistent.

     See also: who, whos_line_format

[Generated from Octave-3.6.4 on 2014-05-21 11:08:22 ]

Examples


## Don't show: 
# roxygen generated flag
options(R_CHECK_RUNNING_EXAMPLES_=TRUE)
## End Don't show

## Don't show: 
 o_clear() 
## End Don't show

.O$a <- 1
.O$b <- 10
o_whos()
##  <Octave session: 2 object(s)>
##  name size bytes  class global sparse complex nesting persistent
##     a  1x1     8 double  FALSE  FALSE   FALSE       1      FALSE
##     b  1x1     8 double  FALSE  FALSE   FALSE       1      FALSE

o_eval("sqrt(2)")
## [1] 1.414
o_whos()
##  <Octave session: 3 object(s)>
##  name size bytes  class global sparse complex nesting persistent
##     a  1x1     8 double  FALSE  FALSE   FALSE       1      FALSE
##   ans  1x1     8 double  FALSE  FALSE   FALSE       1      FALSE
##     b  1x1     8 double  FALSE  FALSE   FALSE       1      FALSE

See also

Other listoct: o_ls, o_who