From 4aef8a3552acb1f724872a110710b1bfcc6bb211 Mon Sep 17 00:00:00 2001
From: Davis King <davis@dlib.net>
Date: Fri, 5 Mar 2010 21:52:40 +0000
Subject: [PATCH] updated docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403534
---
 docs/docs/optimization.xml  |  2 +-
 docs/docs/release_notes.xml | 27 ++++++++++++++++++++++++++-
 2 files changed, 27 insertions(+), 2 deletions(-)

diff --git a/docs/docs/optimization.xml b/docs/docs/optimization.xml
index 4857b42b5..6b6ec9fe0 100644
--- a/docs/docs/optimization.xml
+++ b/docs/docs/optimization.xml
@@ -316,7 +316,7 @@
 <pre>
    Minimize: f(w) == 0.5*dot(w,w) + C*R(w)
 
-   Where R(w) is a convex function and C > 0
+   Where R(w) is a user-supplied convex function and C > 0
 </pre>
 <br/>
 <br/>
diff --git a/docs/docs/release_notes.xml b/docs/docs/release_notes.xml
index 11dfe627c..f689f6408 100644
--- a/docs/docs/release_notes.xml
+++ b/docs/docs/release_notes.xml
@@ -12,13 +12,38 @@
 
 <current>
 New Stuff:
+   - Added the solve_qp_using_smo() function to solve certain quadratic
+     programs.
+   - Added the oca object.  It is an implementation of the Optimized Cutting 
+     Plane Algorithm.
+   - Added a linear SVM trainer that uses oca.
+   - Added an implementation of the Histogram of Oriented Gradients algorithm
+   - Added a simple tool for making image pyramids
+   - Added the running_covariance object 
+   - Added a simple linear (i.e. non-kernelized) kmeans implementation
+   - Added support for serializing dlib::int64
 
 Non-Backwards Compatible Changes:
+   - Changed the definition of dlib's sparse vector format to require
+     unsigned integral keys.  Having this requirement is nice because it 
+     creates a simple correspondence between dense vector index values and 
+     sparse vector keys.  The previous sparse vector definition was  
+     excessively generic.
+   - Renamed sparse_vector::dot_product() to sparse_vector::dot() so that 
+     both dense and sparse vectors have a global function with the same 
+     name (i.e. dot()).
 
 Bug fixes:
+   - Fixed a bug discovered by Mitchell Peabody.  In some instances trying to
+     deserialize a std::vector would fail to compile.  
 
 Other:
-
+   - Increased the number of template arguments of the type_safe_union from 10 
+     to 20.  Additionally, I made the get_id() function public and renamed it 
+     to get_type_id().  I also added a comment explaining the serialization 
+     format of type_safe_union objects.
+   - Moved the optimization algorithms into their own page in the documentation.
+   - Added a Suggested Books page to the documentation
 
 </current>