updated docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%404150

docs/docs/optimization.xml

@@ -47,6 +47,7 @@
          <item>solve_least_squares</item> 
          <item>solve_least_squares_lm</item> 
          <item>solve_trust_region_subproblem</item> 
+         <item>max_cost_assignment</item> 
       </section>
 
       <section>
@@ -426,6 +427,27 @@ subject to the following constraint:
                                  
       </component>
 
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>max_cost_assignment</name>
+         <file>dlib/optimization.h</file>
+         <spec_file link="true">dlib/optimization/max_cost_assignment_abstract.h</spec_file>
+         <description>
+            This function is an implementation of the Hungarian algorithm (also know as the Kuhn-Munkres algorithm).
+            It solves the following optimization problem:
+<pre>
+   Maximize: f(A) == assignment_cost(cost, A)
+   Subject to the following constraints:
+      - The elements of A are unique. That is, there aren't any 
+        elements of A which are equal.  
+      - A.size() == cost.nr()
+</pre>
+<br/>
+         </description>
+                                 
+      </component>
+
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/term_index.xml

@@ -42,6 +42,8 @@
          <term file="optimization.html" name="lagrange_poly_min_extrap"/>
          <term file="optimization.html" name="line_search"/>
          <term file="optimization.html" name="find_min"/>
+         <term file="optimization.html" name="max_cost_assignment"/>
+         <term file="dlib/optimization/max_cost_assignment_abstract.h.html" name="assignment_cost"/>
          <term file="optimization.html" name="solve_least_squares"/>
          <term file="optimization.html" name="solve_least_squares_lm"/>
          <term file="optimization.html" name="find_min_trust_region"/>