updated spec

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403993
This commit is contained in:
Davis King 2010-12-21 20:53:23 +00:00
parent 3aab58b218
commit dbba600f30
1 changed files with 2 additions and 1 deletions

View File

@ -21,9 +21,10 @@ namespace dlib
requires requires
- m.size() > 0 - m.size() > 0
- m.nr() == m.nc() - m.nr() == m.nc()
- m must be a symmetric matrix (i.e. m == trans(m))
- max_size_megabytes >= 0 - max_size_megabytes >= 0
ensures 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 - 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 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. complex matrix expression which is both very large and expensive to evaluate.