annotate matlab/db/contents.m @ 37:89688ebc447f tip

Deprecating this repository.
author samer
date Mon, 05 Jan 2015 17:42:03 +0000
parents 0dd31a8c66bd
children
rev   line source
samer@0 1 % *** db :: functions for dealing with MAT file database
samer@0 2 %
samer@0 3 % The Prolog-Matlab interface module plml requires these functions
samer@0 4 % to manage a database of MAT files and a few other tasks. The MAT
samer@0 5 % file database (matbase) is stored in the file system under a root
samer@0 6 % directory specified by a call to dbroot, eg to specify the
samer@0 7 % directory lib/matbase off your home directory on a host named
samer@0 8 % 'godzilla' (the host name must be supplied to allow for multiple
samer@0 9 % hosts to use the same root directory):
samer@0 10 %
samer@0 11 % dbroot('~/lib/matbase','godzilla');
samer@0 12 %
samer@0 13 % From this point, any calls to dbsave will result in files being
samer@0 14 % created under ~/lib/matbase/godzilla. MAT files in the matbase
samer@0 15 % are referred to using a locator, which is a string of the form
samer@0 16 %
samer@0 17 % <host>/<path>/<filename>|<varname>
samer@0 18 %
samer@0 19 % This refers to a Matlab variable named <varname> in a MAT file
samer@0 20 % whos path is constructed using the matbase root, the host name,
samer@0 21 % and the <path> component of the locator. Eg, after the above
samer@0 22 % dbroot statement, the locator
samer@0 23 %
samer@0 24 % 'godzilla/d0608/m34521|x'
samer@0 25 %
samer@0 26 % refers to the MAT file ~/lib/matbase/godzilla/d0608/m34521.mat
samer@0 27 % NOTE: this is probably not going to work for Windows users due
samer@0 28 % to silly slash vs backslash file separator issues.
samer@0 29 % The functions in this directory are:
samer@0 30 %
samer@0 31 % dbdrop - delete matfile at given locator from matbase
samer@0 32 % dbload - Load value from given matbase locator
samer@0 33 % dbpath - Return full path of matfile given locator
samer@0 34 % dbread - Load values from ASCII file under matbase tree
samer@0 35 % dbroot - Set or retrieve Matbase root directory
samer@0 36 % dbsave - Save object to MatBase using given name
samer@0 37 % dbsaveas - Save object to MatBase using given name
samer@0 38 % dbtmp - Save object to matbase under tmp subtree
samer@0 39 % typecode - Return basic typing information about a value
samer@0 40 % uniquefile - Allocate a unique unused filename
samer@0 41 % uniquevar - Allocate a unique unused variable name
samer@0 42