Moved some of the comments .txt files into the header files.

SheffieldML · Jun 18, 2014 · b0680b5 · b0680b5
1 parent eb3786a
commit b0680b5
Show file tree

Hide file tree

Showing 14 changed files with 41 additions and 41 deletions.
diff --git a/CClctrl.h b/CClctrl.h
@@ -1,3 +1,10 @@
+/* This file and CClctrl.cpp provides a base class for command line control. Various functionality such as parsing arguments and reading input files is provided.
+
+File Notes
+
+21/10/2005 Incorporated William Baxter's isCurrentArg modification.
+
+20/10/2005 Minor modifications by William V. Baxter as part of the porting to Microsoft Visual C++. */
 
 #ifndef CCLCTRL_H
 #define CCLCTRL_H

diff --git a/CClctrl.txt b/CClctrl.txt
diff --git a/CDataModel.h b/CDataModel.h
@@ -1,3 +1,4 @@
+/* Interfaces classes for data sets and mapping models. Long term these classes are expected to be extended. An early set of extensions was rolled back to incorporate William V. Baxter's port to MSVC.*/
 #ifndef CDATAMODEL_H
 #define CDATAMODEL_H
 #include <iostream>

diff --git a/CDataModel.txt b/CDataModel.txt
diff --git a/CDist.h b/CDist.h
@@ -1,3 +1,10 @@
+/* This file contains distributions which can be used as priors over parameters. 
+
+16/11/2005 Fixed a bug associated with loading more than one prior.
+
+21/10/2005 Further minor updates to header.
+
+20/10/2005 File updated to include William V. Baxter's corrections which allow the file to be compiled under MSVC. Most corrections involve removing redundant const values. */
 #ifndef CDIST_H
 #define CDIST_H
 #include <cmath>

diff --git a/CDist.txt b/CDist.txt
diff --git a/CGplvm.h b/CGplvm.h
@@ -1,3 +1,11 @@
+/* This file contains classes for representing Gaussian processes latent variable models. The model relies on the CKern class.
+
+05/11/2005 Changed use of abs (which was calling f2c code) to fabs to improve compatability with MSVC.
+
+21/10/2005 Major structural changes to the class. William V. Baxter has included code to allow the `GP-DM' of Wang et al. to be run with this code. As part of this change the back constrained classes and the standard model have been merged. There are many comments added as part of Bill's addition of this material. For the moment, 
+
+20/10/2005 Incorporating William V. Baxter's changes for compiling under MSVC. In this file key changes include, use of the new addVal matrix method, addition of comments Bill used while going through the code (which may be helpful to other users). Finally there are a couple of code tidy ups (formatting etc.). */
+
 #ifndef CGPLVM_H
 #define CGPLVM_H
 #include "CMltools.h"

diff --git a/CGplvm.txt b/CGplvm.txt
diff --git a/CKern.h b/CKern.h
@@ -1,3 +1,13 @@
+/* This file and CKern.cpp contains classes for representing kernels. These classes do not store the kernel matrix, they merely store the kernels characteristics. There are several types of kernel provided, and it should be easy to add others. CCmpndKern provides a class which forms an additive kernel from individual kernels (i.e. a linear plus an RBF kernel).
+
+16/03/2007 Added code to compute parameter gradients when two X matrices are provided. This enables use of the toolbox with DTC, FITC, PITC approximations. Also changed the transformation of kernel parameters to be by exponential rather than negLogLogit, in line with the default in the MATLAB kern toolbox.
+
+22/10/2005 Added updateX method to class, from William V. Baxter's changes to make computation more efficient. The changes involve precomputing the distance matrix and a portion of the kernel matrix and storing it for later use. UpdateX is called when X has changed so that these stored values are recomputed.
+
+21/10/2005 More changes from William V. Baxter. Most are removal of redundant const modifiers, but also vector<CMatrix*> is now being passed as a reference, rather than by value.
+
+20/10/2005 Incorporated changes from William V. Baxter to allow compilation under MSVC. */
+
 #ifndef CKERN_H
 #define CKERN_H
 #include <cmath>

diff --git a/CKern.txt b/CKern.txt
diff --git a/CMltools.h b/CMltools.h
@@ -1,3 +1,4 @@
+/* This file and CMltools.cpp contain classes for general machine learning models such as multi-layer perceptrons. */
 #ifndef CMLTOOLS_H
 #define CMLTOOLS_H
 

diff --git a/CMltools.txt b/CMltools.txt
diff --git a/COptimisable.h b/COptimisable.h
@@ -1,3 +1,10 @@
+/*This file contains a base class for optimisation. In particular it contains an implementation of the Scaled Conjugate Gradient optimisation routine.
+
+05/11/2005 Changed use of abs (which was calling f2c code) to fabs to improve compatability with MSVC.
+
+21/10/2005 More minor changes from Bill. 
+
+20/10/2005 Minor changes by William V. Baxter for MSVC compatibility. This principally removing an unused variable and changing the file in which the constants were declared. */
 #ifndef COPTIMISABLE_H
 #define COPTIMISABLE_H
 #include "CMatrix.h"

diff --git a/COptimisable.txt b/COptimisable.txt