MemCom Reference Manual

Table of Contents

I. MemCom Architecture

1. Introduction

1. The Database Manager (DB)

2. The Neutral File Manager (NM)

3. The Array Table Subsystem (AT)

4. The Sparse Table Subsystem (ST)

2. Datasets

1. Dataset Identification and Description

2. Data Types

3. Dataset length specification

4. Reading of datasets from databases

3. The Database Manager (DB)

1. Paged input/output mode versus direct input/output mode

2. Paged input/output mode

3. Raw data access

4. Relational Tables and the Relational Table Manager (TB)

5. Array Tables and the Array Table Manager (AT)

6. Sparse Tables and the Sparse Table Manager (ST)

7. The Dynamic Memory Manager (DMM)

8. The Application Program Interfaces

II. MemCom C API Manual Pages

1. Database Manager Functions

mcDBchangeSetDimensions — Change dimensions of dataset on database

mcDBcloseFile — Close MemCom database

mcDBcopySet — Copy dataset

mcDBcopySetsel — Copy selected datasets

mcDBcreateSet — Create dataset on database

mcDBdeleteSet — Delete dataset on database

mcDBfree — Free dataset allocated by MemCom

mcDBgetSet — Read dataset from database

mcDBgetSetNext — Get next set in database

mcDBgetSetNextIter — Get next set in database

mcDBgetSetStr — Read string from dataset

mcDBgetSetpos — Read set by position from database

mcDBgetSetslice — Read a slice of a dataset

mcDBgetStream — Read from stream

mcDBgetSubset — Read sub-set from database

mcDBgetSubsetStr — Read string from sub-set

mcDBinitSet — Initialize set on database with value

mcDBinqFileAtt — Inquire database attributes

mcDBinqFileIOType — Inquire database input/output type

mcDBinqSetAtt — inquire dataset attributes

mcDBisFile — Check if file is MemCom database

mcDBisHandle — Check if file handle is valid

mcDBopenFile — Open MemCom database

mcDBopenFileBuffered — Open MemCom database

mcDBpack — Pack (defragment) database

mcDBprintDir — Print database directory

mcDBprintFileHeader — Print database header

mcDBprintSet — Print dataset

mcDBputSet — Write dataset to database

mcDBputSetStr — Write string to dataset

mcDBputSetpos — Write portion of sub-set to database

mcDBputSetslice — Write slice of dataset to database

mcDBputStream — Write to stream

mcDBputSubset — Write sub-set to database

mcDBputSubsetStr — Write string to sub-set

mcDBrenameSet — Rename dataset

mcDBresSet — Create dataset on database

mcDBresSuperset — Create super-set on database

mcDBsaveFile — Save current database

2. Relational Table Manager Functions

mcTBclear — Clear relational table

mcTBcreate — Create relational table

mcTBcreateDesc — Create descriptor table

mcTBdel — Delete key

mcTBext — Extract data from relational table

mcTBfree — Free relational table in memory

mcTBgetTableSize — Return the total table size

mcTBgetTableSizeUsed — Return the size used

mcTBinq — Inquire attributes of key

mcTBins — Insert data in relational table

mcTBload — Load relational table

mcTBloadDesc — Load dataset descriptor table

mcTBnextObj — Get attributes of next key

mcTBnextObjIter — Get attributes of next key

mcTBprint — Print content of relational table

mcTBrep — Replace data in relational table

mcTBsetDescSize — Specify the descriptor table size

mcTBstore — Store relational table

mcTBstoreDesc — Store dataset descriptor table

3. Array Table Functions

mcATcreateTable — Create array table

mcATputCell — Insert data in cell of array table

mcATgetCell — Extract data from cell of array table

mcATinqColAtt — Get column attributes of array table

mcATinqCellIndex — Get column number of array table

mcATprintTableHeader — Print table header of array table

4. Sparse Table Functions

mcSTdatasetCreate — Create a sparse-table dataset

mcSTdatasetOpen — Open a sparse-table dataset

mcSTdatasetClose — Close a sparse-table dataset

mcSTdatasetName — Get the name of a sparse-table dataset

mcSTdatasetDatabaseHandle — Get the name of a sparse-table dataset

mcSTdatasetClear — Clear all contents of a sparse-table dataset

mcSTcolNum — Get the current number of columns for a sparse-table dataset

mcSTcolAppend — Append a new column to a sparse-table dataset

mcSTcolFind — Lookup sparse-table columns by name

mcSTcolAttributes — Obtain the attributes of a column of a sparse-table dataset

mcSTrowNum — Get the current number of rows for a sparse-table dataset

mcSTrowAppend — Append one or more empty rows to a sparse-table dataset

mcSTrowNumCells — Get the number of non-empty cells of a sparse-table dataset

mcSTrowClear — Clear all non-empty cells of a row of the a sparse-table dataset

mcSTrowSort — Sort the non-empty cells of a row of a sparse-table dataset

mcSTcellClear — Clear a sparse-table cell

mcSTcellSet — Set the cell data

mcSTcellSetK — Set data for a character-string cell.

mcSTcellGet — Get a pointer to the data buffer of a sparse-table cell

mcSTcellGetCopy — Get a pointer to buffer containing a copy of the data of a sparse-table cell

mcSTcellGetArray — Copy the cell data into a buffer

mcSTcellNumElements — Get the number of data elements of a sparse-table cell

mcSTcellSize — Get data size (number of bytes) of a sparse-table cell

mcSTcellFindNext — Get the next non-empty sparse-table cell

5. Utility Functions

mcConv — Convert float data in memory

mcConvFmt — Convert a format string

mcErrPrint — Print MemCom error code

mcErrReset — Reset MemCom error status

mcErrSetOutput — Set the error output flag

mcErrStatus — Return MemCom error status

mcErrTermLevel — Set the program termination flag

mcErrGetMsg — Get the message associated with a MemCom error code.

mcExit — Terminate MemCom (C API)

mcIntToA — Convert an integer or offset number to ASCII

mcParamGet — Get MemCom system parameters

mcParamPut — Get MemCom system parameters

mcPrint — Safe and Portable Formatted Output Conversion

mcSizeof — Get size in bytes for MemCom data type element

mcStringDecomp — Decompose fields of string

mcStringName — Create composite dataset name

mcStringTrim — Remove leading and trailing white space characters

mcTimeAscDate — Get Date (ASCII format)

mcTimeCPU — Get processor time

mcTimeIntDaytime — Get daytime (integer format)

mcTimeWT — Get wall time

mcVersion — Get current MemCom version number

6. Client/Server Functions

mcBegin — Begin a New Transaction (C API)

mcEnd — End an Active Transaction (C API)

mcGetBlocking — Get the blocking mode to a remote database (C API)

mcGetDataPtr — Return a pointer to data in memory after a completed operation (C API)

mcGetRemoteFD — Get the file descriptor of the connection to a MemCom server (C API)

mcIsReceive — Tell if data from server is to be expected (C API)

mcIsSend — Tell if data needs to be sent to server (C API)

mcSetBlocking — Set the blocking mode to a remote database (C API)

mcTest — Test if a non-blocking operation has completed (C API)

mcTestAll — Test if all non-blocking operations have completed (C API)

mcTestAny — Test if any non-blocking operation has completed (C API)

mcWait — Block until a remote operation has completed (C API)

mcWaitAll — Block until all remote operations have completed (C API)

mcWaitAny — Block until any remote operation has completed (C API)

7. The Neutral File Formatter

mcNMopen — Open neutral file (C API)

mcNMclose — Close neutral file (C API)

mcNMwrite — Write to neutral file (C API)

mcNMread — read from neutral file (C API)

III. MemCom ftn Fortran API

1. Database Manager (DB)

mcf_db_close — Close MemCom database file (Fortran API)

mcf_db_copy — Copy dataset (Fortran API)

mcf_db_create_set — Create dataset on database file (Fortran API)

mcf_db_delete_set — Delete dataset (Fortran API)

mcf_db_init_set — Initialize dataset with value (Fortran API)

mcf_db_get_set — Read data from database file (Fortran API)

mcf_db_get_set_pos — Read data from database file (Fortran API)

mcf_db_get_set_att — Get dataset attributes (Fortran API)

mcf_db_get_stream — Read from stream (Fortran API)

mcf_db_isdb — Check if MemCom database file exists (Fortran API)

mcf_db_ishandle — Check MemCom database file handle (Fortran API)

mcf_db_isset — Check if a dataset exists (Fortran API)

mcf_db_open — Open MemCom database file (Fortran API)

mcf_db_pack — Pack (de-fragment) database file (Fortran API)

mcf_db_print_directory — Print database file directory (Fortran API)

mcf_db_print_set — Print dataset (Fortran API)

mcf_db_put_set — Write positional dataset to database file (Fortran API)

mcf_db_put_set_pos — Write positional dataset to database file (Fortran API)

mcf_db_put_stream — Write to stream (Fortran API)

mcf_db_rename_set — Rename dataset (Fortran API)

mcf_db_save — Save database file (Fortran API)

mcf_db_ldiv_set — Change number of columns of dataset (Fortran API)

2. Relational Table Manager (TB)

mcf_tb_clear — Clear table buffer (Fortran API)

mcf_tb_create — Create new relational table (Fortran API)

mcf_tb_delete — (Fortran API)

mcf_tb_extract — Extract data from relational table (Fortran API)

mcf_tb_extract_u — Extract data from relational table (Fortran API)

mcf_tb_free — Free relational table in table buffer (Fortran API)

mcf_tb_get — Load relational table (Fortran API)

mcf_tb_get_key_att — Get attributes of table entry (Fortran API)

mcf_tb_insert — Insert data in relational table (Fortran API)

mcf_tb_print — Print content of relational table (Fortran API)

mcf_tb_replace — Insert data in relational table (Fortran API)

mcf_tb_put — Write relational table to database file (Fortran API)

mcf_tb_scan — (Fortran API)

3. Sparse Table Functions

mcf_st_dataset_create — Create a sparse-table dataset

mcf_st_dataset_open — Open a sparse-table dataset

mcf_st_dataset_close — Close a sparse-table dataset

mcf_st_dataset_name — Get the name of a sparse-table dataset

mcf_st_dataset_database_handle — Get the database handle

mcf_st_dataset_clear — Clear all contents of a sparse-table dataset

mcf_st_col_num — Get the current number of columns for a sparse-table dataset

mcf_st_col_append — Append a new column to a sparse-table dataset

mcf_st_col_find — Lookup sparse-table columns by name

mcf_st_col_attributes — Obtain the attributes of a column of a sparse-table dataset

mcf_st_row_num — Get the current number of rows for a sparse-table dataset

mcf_st_row_append — Append one or more empty rows to a sparse-table dataset

mcf_st_row_num_cells — Get the number of non-empty cells of a row of a sparse-table dataset

mcf_st_row_clear — Clear all non-empty cells of a row of a sparse-table dataset

mcf_st_row_sort — Sort the non-empty cells of a row of a sparse-table dataset

mcf_st_cell_clear — Clear a sparse-table cell

mcf_st_cell_set — Set the cell data

mcf_st_cell_set_char — Set data for a character-string cell.

mcf_st_cell_get — Copy the data of a sparse-table cell to a buffer

mcf_st_cell_get_char — Copy the data of a sparse-table cell of type 'K' to a buffer

mcf_st_cell_num_elements — Get the number of data elements of a sparse-table cell

mcf_st_cell_find_next — Get the next non-empty sparse-table cell

4. Dynamic Memory Manager (DMM)

dmmptr — DMM offset start index

mcf_dmm_allocate — Allocate dynamic memory

mcf_dmm_check — Check dynamic memory

mcf_dmm_clear — Clear dynamic memory

mcf_dmm_create_set — Create dataset in DMM and on database

mcf_dmm_close — Close

mcf_dmm_delete — Delete object from Dynamic Memory

mcf_dmm_get_set — Load data set in Dynamic Memory

mcf_dmm_get_ident — Get DMM identifier of object

mcf_dmm_get_parameter — Get DMM parameter

mcf_dmm_init — Initialize DMM

mcf_dmm_get_att — Get attributes of DMM object

mcf_dmm_load_set — Load data set in Dynamic Memory

mcf_dmm_open — Open DM system

mcf_dmm_print — Print content of a DMM object

mcf_dmm_print_status — Print content of a DMM object.

mcf_dmm_put_set — Copy data to database

mcf_dmm_reallocate — Reallocate DMM objects

mcf_dmm_set_parameter — Modify DMM parameters

mcf_dmm_set_tag — Set user code

mcf_dmm_trace — Print DMM allocation trace to file

5. The Neutral File Formatter (NM)

mcf_nm_open — Open neutral file

mcf_nm_close — Close neutral file

mcf_nm_write — Write to neutral file

mcf_nm_read — read from neutral file

6. Utility Functions

mcf_abort — Abort process

mcf_exit — Terminate MemCom (Fortran API)

mcf_get_version — Get MemCom version (string)

mcf_initialize — Initialize MemCom system

mcf_mkdir — Create directory

mcf_stop — Terminate MemCom system and exit process

IV. MemCom (Old) Fortran77 API

1. Database Manager Functions

ciodb — Change database input/output mode

compdb — Compare datasets

cp — Copy datasets

dbfvers — Get MemCom version of database

defragdb — Pack (defragment) database

deldb — Delete dataset on database

dir — Print directory of database

dss — Create set with sub-divisions

enddb — Close database

filedb — Check existence of database

foffdb — Get file offset of dataset

getdb — Read dataset

gtlddb — Inquire size of dataset descriptor

inqsdb — Check existence of dataset

inqudb — Inquire next free database handle

ldivdb — Change size of sub-set

lgtdb — Inquire attributes of dataset

nsetdb — Get number of datasets

open — Open database

prpdb — Inquire attributes of dataset

put — Write datasets to database

rendb — Rename dataset

res — Create dataset

savedb — Save database status

sizedb — Inquire size of database

vdb — Paged low-level input/output system

wa — Low-level word-addressable input/output mode

2. Relational Table Manager Functions

attrtb — Inquire attributes of key

clrtb — Clear Table Buffer

deletb — Delete key from table

gatttb — Scan relational table

getbw — Extract scalar keys from table

getba — Extract numerical arrays from keys

getdes — Load dataset descriptor

gettab — Load relational table

lgttb — Inquire current size of relational table

ncrtb — Set table buffer clear flag

prttb — Print content of relational tables

putbw — Insert scalar data in table

putba — Insert data in table

putdes — Write dataset descriptor to database

puttab — Write relational table to database

restab — Create new relational table on database

rptb — Replace data in table

rptba — Replace data table

3. The Dynamic Memory Manager (DMM)

dmmptr — Dynamic Memory Manager offset

dmmaat — Add attributes to DMM dataset

dmmall — Allocate dynamic memory

dmmauc — Add user code to DMM dataset

dmmcheck — Check dynamic memory

dmmcle — Clear dynamic memory

dmmcls — Close Dynamic Memory Manager

dmmd2s — Convert double to single

dmmdel — Delete dataset from Dynamic Memory

dmmexi — Check if dataset exists in DMM

dmmgad — Get DMM array offset of dataset

dmmgat — Inquire database attributes of dataset in DMM

dmmget — Load dataset from database

dmmgets — Load dataset from database

dmmgetfp — Load dataset from database to DMM

dmmgpr — Inquire DMM system parameters

dmmgsi — Inquire identifier of dataset

dmmgshandle — Inquire identifier of dataset

dmminq — Inquire attributes of dataset

dmmload — Load dataset from database

dmmope — Open Dynamic Memory Manager

dmmppr — Set DMM parameters

dmmpri — Print content of dataset

dmmput — Write dataset to database

dmmrea — Re-allocate dataset

dmmres — Create dataset

dmmrfa — Change DMM offset

dmmrid — Delete dataset

dmmsiz — Inquire size of dataset

dmmsta — Print DMM status

dmmsuc — Set default user code

dmmtoc — Print directory of DMM stack

dmmtrace — Logs all DMM requests to file

4. Utility Functions

ascdat — Get current date

getcpu — Inquire elapsed CPU time

getel — Inquire elapsed wall time

getvers — Return current MemCom version

gprmdb — Get database manager parameters

iaddr — Return address of variable

inttim — Get time of the day

mcdtimes — Get time stamp

mcfexit — Terminate MemCom (Fortran API)

mcloc — Inquire address of variable

mctimes — Get time stamp

pprmdb — Set database system parameter

rdm — Random number generator

ucwait — Unconditional wait

V. The MemCom Tools and Utilities

1. Introduction

mcchecklicense — Verify if MemCom license is correct

mcconv7 — Convert MemCom 6 database to MemCom 7 format

mcfromnf — Convert neutral file to MemCom database

mcinfo — Print MemCom database status

misdbfile — Check if file is a MemCom database

mcprot — Set database protection code

mcserver — MemCom Server Program

mctonf — Convert MemCom database to neutral file

mctonf — Print version of current Memom installation

pymcmon — The MemCom Python interpreter

A. MemCom Error Codes

B. MemCom Settings and Limitations

C. Conversion from MemCom version 6 to Version 7

1. New database structure

2. Set size and database addresses

3. MemCom 6 libraries and executables

4. MemCom 6 and MemCom 7 C API functions

D. The MemCom Database Structure

1. File Structure

1.1. The header file

1.2. The index file

1.3. The data files

2. The Relational Table Structure

3. The Array Table Structure

4. The Sparse-Table Structure

4.1. The Sparse-Table Data File

4.2. The Superblock

4.3. Packet Types

4.4. Structure of Root Packets

4.5. Structure of Colindex Packets

4.6. Structure of Rowindex Packets

4.7. Structure of Row Packets

5. The Neutral File Format

E. Installation Notes

1. Installing SMR Software

2. Configuring SMR Software

3. Testing SMR Software

4. Viewing the documentation

5. Updating SMR Software

6. De-installing SMR Software

F. Release Notes

1. Version 7.7

1.1. Version 7.7.10 (December 2015)

2. Version 7.6

2.1. Version 7.6.10 (November 2014)

2.2. Version 7.6.9 (November 2013)

2.3. Version 7.6.5 - 7.6.8

2.4. Version 7.6.4

2.5. Version 7.6.2

2.6. Version 7.6.1

2.7. Version 7.6.0

G. Glossary

Glossary

Index