Next: Hashing Functions, Previous: Group Database Functions, Up: System Utilities [Contents][Index]

### 36.11 System Information

Function File: computer ()
Function File: c = computer ()
Function File: [c, maxsize] = computer ()
Function File: [c, maxsize, endian] = computer ()
Function File: arch = computer ("arch")

  Print or return a string of the form cpu-vendor-os that identifies the type of computer that Octave is running on.

  If invoked with an output argument, the value is returned instead of printed. For example:

      computer ()
         -| i586-pc-linux-gnu

      mycomp = computer ()
         ⇒ mycomp = "i586-pc-linux-gnu"

  If two output arguments are requested, also return the maximum number of elements for an array. This will depend on whether Octave has been compiled with 32-bit or 64-bit index vectors.

  If three output arguments are requested, also return the byte order of the current system as a character (`"B"` for big-endian or `"L"` for little-endian).

  If the argument `"arch"` is specified, return a string indicating the architecture of the computer on which Octave is running.

  See also: isunix, ismac, ispc.

Built-in Function: [uts, err, msg] = uname ()

  Return system information in the structure. For example:

      uname ()
         ⇒ {
               sysname = x86_64
               nodename = segfault
               release = 2.6.15-1-amd64-k8-smp
               version = Linux
               machine = #2 SMP Thu Feb 23 04:57:49 UTC 2006
            }

  If successful, err is 0 and msg is an empty string. Otherwise, err is nonzero and msg contains a system-dependent error message.

Built-in Function: nproc ()
Built-in Function: nproc (query)

  Return the current number of available processors.

  If called with the optional argument query, modify how processors are counted as follows:

  `all`

    total number of processors.

  `current`

    processors available to the current process.

  `overridable`

    likewise, but overridable through the `OMP_NUM_THREADS` environment variable.

Function File: ispc ()

  Return true if Octave is running on a Windows system and false otherwise.

  See also: isunix, ismac.

Function File: isunix ()

  Return true if Octave is running on a Unix-like system and false otherwise.

  See also: ismac, ispc.

Function File: ismac ()

  Return true if Octave is running on a Mac OS X system and false otherwise.

  See also: isunix, ispc.

Built-in Function: isieee ()

  Return true if your computer claims to conform to the IEEE standard for floating point calculations. No actual tests are performed.

Function File: isdeployed ()

  Return true if the current program has been compiled and is running separately from the Octave interpreter and false if it is running in the Octave interpreter.

  Currently, this function always returns false in Octave.

Built-in Function: isstudent ()

  Return true if running in the student edition of MATLAB.

  `isstudent` always returns false in Octave.

  See also: false.

Built-in Function: OCTAVE_HOME ()

  Return the name of the top-level Octave installation directory.

  See also: EXEC_PATH, IMAGE_PATH.

Function File: matlabroot ()

  Return the name of the top-level Octave installation directory.

  This is an alias for the function `OCTAVE_HOME` provided for compatibility.

  See also: OCTAVE_HOME.

Built-in Function: OCTAVE_VERSION ()

  Return the version number of Octave as a string.

  See also: ver, version.

Function File: version ()

  Return the version number of Octave as a string.

  This is an alias for the function `OCTAVE_VERSION` provided for compatibility.

  See also: OCTAVE_VERSION, ver.

Function File: ver
Function File: ver Octave
Function File: ver package
Function File: v = ver (…)

  Display a header containing the current Octave version number, license string, and operating system. The header is followed by a list of installed packages, versions, and installation directories.

  Use the package name package or Octave to limit the listing to a desired component.

  When called with an output argument, return a vector of structures describing Octave and each installed package. The structure includes the following fields.

  `Name`

    Package name.

  `Version`

    Version of the package.

  `Revision`

    Revision of the package.

  `Date`

    Date of the version/revision.

  See also: version, octave_config_info, usejava, pkg.

Function File: compare_versions (v1, v2, operator)

  Compare two version strings using the given operator.

  This function assumes that versions v1 and v2 are arbitrarily long strings made of numeric and period characters possibly followed by an arbitrary string (e.g., `"1.2.3"`, `"0.3"`, `"0.1.2+"`, or `"1.2.3.4-test1"`).

  The version is first split into numeric and character portions and then the parts are padded to be the same length (i.e., `"1.1"` would be padded to be `"1.1.0"` when being compared with `"1.1.1"`, and separately, the character parts of the strings are padded with nulls).

  The operator can be any logical operator from the set

  - `"=="` equal
  - `"<"` less than
  - `"<="` less than or equal to
  - `">"` greater than
  - `">="` greater than or equal to
  - `"!="` not equal
  - `"~="` not equal

  Note that version `"1.1-test2"` will compare as greater than `"1.1-test10"`. Also, since the numeric part is compared first, `"a"` compares less than `"1a"` because the second string starts with a numeric part even though `double ("a")` is greater than `double ("1").`

Command: license
Command: license inuse
Command: license inuse feature
Function File: license ("inuse")
Function File: retval = license ("inuse")
Function File: retval = license ("test", feature)
Function File: retval = license ("checkout", feature)
Function File: [retval, errmsg] = license ("checkout", feature)

  Get license information for Octave and Octave packages.

  GNU Octave is free software distributed under the GNU General Public License (GPL), and a license manager makes no sense. This function is provided only for MATLAB compatibility.

  When called with no extra input arguments, it returns the Octave license, otherwise the first input defines the operation mode and must be one of the following strings: `inuse`, `test`, and `checkout`. The optional feature argument can either be `"octave"` (core), or an Octave package.

  `"inuse"`

    Returns a list of loaded features, i.e., octave and the list of loaded packages. If an output is requested, it returns a struct array with the fields `"feature"`, and `"user"`.

  `"test"`

    Return true if the specified feature is installed, false otherwise.

    An optional third argument `"enable"` or `"disable"` is accepted but ignored.

  `"checkout"`

    Return true if the specified feature is installed, false otherwise. An optional second output will have an error message if a package is not installed.

  See also: pkg, ver, version.

Built-in Function: octave_config_info ()
Built-in Function: octave_config_info (option)

  Return a structure containing configuration and installation information for Octave.

  If option is a string, return the configuration information for the specified option.

  See also: computer.

Built-in Function: getrusage ()

  Return a structure containing a number of statistics about the current Octave process. Not all fields are available on all systems. If it is not possible to get CPU time statistics, the CPU time slots are set to zero. Other missing data are replaced by NaN. The list of possible fields is:

  `idrss`

    Unshared data size.

  `inblock`

    Number of block input operations.

  `isrss`

    Unshared stack size.

  `ixrss`

    Shared memory size.

  `majflt`

    Number of major page faults.

  `maxrss`

    Maximum data size.

  `minflt`

    Number of minor page faults.

  `msgrcv`

    Number of messages received.

  `msgsnd`

    Number of messages sent.

  `nivcsw`

    Number of involuntary context switches.

  `nsignals`

    Number of signals received.

  `nswap`

    Number of swaps.

  `nvcsw`

    Number of voluntary context switches.

  `oublock`

    Number of block output operations.

  `stime`

    A structure containing the system CPU time used. The structure has the elements `sec` (seconds) `usec` (microseconds).

  `utime`

    A structure containing the user CPU time used. The structure has the elements `sec` (seconds) `usec` (microseconds).

Next: Hashing Functions, Previous: Group Database Functions, Up: System Utilities [Contents][Index]