NextCloud/dlib
1
0
Fork 0
mirror of https://github.com/davisking/dlib.git synced 2024-11-01 10:14:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added some missing comments and asserts.

Browse Source 
--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402854
This commit is contained in:
Davis King 2009-02-03 03:19:10 +00:00
parent ea575d03bf
commit 0e02ea50d1
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
dlib/matrix/matrix_la.h
View File

@ -1515,6 +1515,10 @@ convergence:
const matrix_exp<EXP>& m
)
{
// You can only use this function with matrices that contain float or double values
COMPILE_TIME_ASSERT((is_same_type<typename EXP::type, float>::value ||
is_same_type<typename EXP::type, double>::value));
DLIB_ASSERT(m.nr() == m.nc(),
"\tconst matrix real_eigenvalues()"
<< "\n\tYou have given an invalidly sized matrix"

5
dlib/matrix/matrix_la_abstract.h
View File

@ -132,6 +132,7 @@ namespace dlib
/*!
requires
- m.nr() == m.nc()
- matrix_exp::type == float or double
ensures
- returns a matrix E such that:
- E.nr() == m.nr()
@ -216,6 +217,7 @@ namespace dlib
REQUIREMENTS ON matrix_exp_type
must be some kind of matrix expression as defined in the
dlib/matrix/matrix_abstract.h file. (e.g. a dlib::matrix object)
The matrix type must also contain float or double values.
WHAT THIS OBJECT REPRESENTS
This object represents something that can compute an LU
@ -361,6 +363,7 @@ namespace dlib
REQUIREMENTS ON matrix_exp_type
must be some kind of matrix expression as defined in the
dlib/matrix/matrix_abstract.h file. (e.g. a dlib::matrix object)
The matrix type must also contain float or double values.
WHAT THIS OBJECT REPRESENTS
This object represents something that can compute a cholesky
@ -453,6 +456,7 @@ namespace dlib
REQUIREMENTS ON matrix_exp_type
must be some kind of matrix expression as defined in the
dlib/matrix/matrix_abstract.h file. (e.g. a dlib::matrix object)
The matrix type must also contain float or double values.
WHAT THIS OBJECT REPRESENTS
This object represents something that can compute a classical
@ -589,6 +593,7 @@ namespace dlib
REQUIREMENTS ON matrix_exp_type
must be some kind of matrix expression as defined in the
dlib/matrix/matrix_abstract.h file. (e.g. a dlib::matrix object)
The matrix type must also contain float or double values.
WHAT THIS OBJECT REPRESENTS
This object represents something that can compute an eigenvalue