clarified docs

ae3ae70a · Davis King · 8e537c97 · ae3ae70a
Commit ae3ae70a authored Sep 03, 2012 by Davis King
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

matrix_utilities_abstract.h dlib/matrix/matrix_utilities_abstract.h +4 -0

No files found.
--- a/dlib/matrix/matrix_utilities_abstract.h
+++ b/dlib/matrix/matrix_utilities_abstract.h
@@ -1065,6 +1065,10 @@ namespace dlib
        ensures
            - returns sqrt(sum(squared(m)))
              (i.e. returns the length of the vector m)
+            - if (m contains integer valued elements) then  
+                - The return type is a double that represents the length.  Therefore, the
+                  return value of length() is always represented using a floating point
+                  type. 
    !*/

 // ----------------------------------------------------------------------------------------