/*****************************************************************************
  FILE           : README
  SHORTNAME      : readme
  SNNS VERSION   : 3.1

  PURPOSE        : Readme File for the SNNS Kernel V3.1
  NOTES          :

  AUTHOR         : Guenter Mamier
  DATE           : 

  CHANGED BY     : 
  IDENTIFICATION : @(#)README	1.8 8/20/93
  SCCS VERSION   : 1.8
  LAST CHANGE    : 8/20/93

             (c) 1992,1993 by  and the SNNS-Group

******************************************************************************/


This Directory contains the following files:

README          :       This file
makefile.sun    :       Makefile for SUN C-Compilers
makefile.dec    :       Makefile for DEC C-Compilers
makefile.gcc    :       Makefile for GNU C-Compilers
makefile.bcc    :       Makefile for the Borland C++ V3.0 Compiler
                        (running under MS-DOS)

art_ui.c        :       contains user interface functions for ART networks
arttr_f.c       :       contains transfer functions for ART networks
calc_err.c      :       Program for calculating the accurancy of activation
                        functions that uses the table-lookup technique
cc_learn.c	:	contains learning functions for cascade correlation
cc_rcc.c	:	contains common functions for cc and rec. cc
cc_rcc_topo.c	:	contains topology specs for cc and rcc
dlvq_learn.c    :	contains all functions of the DLVQ algorithm
func_tbl.c      :       contains the function table
init_f.c        :       contains the network initialisation functions
kernel.c        :       contains the simulator kernel
kr_amap.c       :       contains kernel functions for ARTMAP networks.
kr_art.c        :       contains kernel functions for all ART networks
kr_art1.c       :       contains kernel functions for ART1 networks
kr_art2.c       :       contains kernel functions for ART2 networks
kr_funcs.c      :       contains internal interface functions of the kernel
kr_inversion.c  :	contains network inversion functions
kr_io.c         :       contains the file I/O interface functions
kr_mem.c        :       contains the memory management functions of the kernel
kr_td.c		:	contains the learning functions for time delay networks
kr_ui.c         :       contains the user interface functions
learn_f.c       :       contains the learning functions
m_art.c         :       Program (MAKEART) that creates ART networks
                        (ART1, ART2, ARTMAP)
m_art1.c        :       Source file belonging to m_art.c, contains functions
                        for creation of ART1 networks.
m_art2.c        :       Source file belonging to m_art.c, contains functions
                        for creation of ART2 networks.
m_artmap.c      :       Source file belonging to m_art.c, contains functions
                        for creation of ARTMAP networks.
matrix.c        :       contains matrix operation functions
netlearn.c      :       Program for training networks
netperf.c       :       SNNS benchmark test program
rcc_learn.c	:       learning functions of recurrent cascade correlation
snnsbat.c       :       Program for training networks in the background
strdup.c        :       Compatibility source file for ULTRIX-32 and MS-DOS
tbl_func.c      :       contains the activation functions using table-lookup.
trans_f.c       :       contains the network transfer functions
update_f.c      :       contains the network update functions


All these source files have two corresponding headder files. A .h file that 
contains the external declarations for the functions accessible from other
moduls, and a .ph file for function prototypes and definitions local to the 
modul.

Additionally there are the following 'global header files:

art_typ.h       :       contains global data types and constants for external 
                        programs using ART networks.
ext_typ.h       :       contains data types for external kernels
func_mac.h      :       contains macros for transfer functions
glob_typ.h      :       contains global data types and constants
                        for external programs
krart_df.h      :       contains constants and macros for all ART algorithms
krui_typ.h      :       contains ANSII prototypes of kr_ui.c
kr_const.h      :       contains kernel constants
kr_def.h        :       contains kernel default values
kr_mac.h        :       contains kernel macros
kr_typ.h        :       contains kernel data types and constants
version.h       :       contains the version numbers of the kernel


