From dbba600f30d0b6cef1af3c2448dbe58e304bb30a Mon Sep 17 00:00:00 2001 From: Davis King Date: Tue, 21 Dec 2010 20:53:23 +0000 Subject: [PATCH] updated spec --HG-- extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403993 --- dlib/matrix/symmetric_matrix_cache_abstract.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dlib/matrix/symmetric_matrix_cache_abstract.h b/dlib/matrix/symmetric_matrix_cache_abstract.h index 63ab347d7..f74b56ab4 100644 --- a/dlib/matrix/symmetric_matrix_cache_abstract.h +++ b/dlib/matrix/symmetric_matrix_cache_abstract.h @@ -21,9 +21,10 @@ namespace dlib requires - m.size() > 0 - m.nr() == m.nc() - - m must be a symmetric matrix (i.e. m == trans(m)) - max_size_megabytes >= 0 ensures + - This function assumes that m is symmetric. If m is not symmetric then it won't + crash but you will get incorrect results. - This method creates a matrix expression which internally caches the elements of m so that they can be accessed quickly. It is useful if m is some kind of complex matrix expression which is both very large and expensive to evaluate.