[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Toon-members] TooN Doxyfile TooN.h doc/documentation.h intern...
|
From: |
Edward Rosten |
|
Subject: |
[Toon-members] TooN Doxyfile TooN.h doc/documentation.h intern... |
|
Date: |
Mon, 27 Jul 2009 16:39:43 +0000 |
CVSROOT: /cvsroot/toon
Module name: TooN
Changes by: Edward Rosten <edrosten> 09/07/27 16:39:43
Modified files:
. : Doxyfile TooN.h
doc : documentation.h
internal : config.hh matrix.hh objects.h operators.hh
reference.hh vector.hh
Log message:
More documentation.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/TooN/Doxyfile?cvsroot=toon&r1=1.8&r2=1.9
http://cvs.savannah.gnu.org/viewcvs/TooN/TooN.h?cvsroot=toon&r1=1.49&r2=1.50
http://cvs.savannah.gnu.org/viewcvs/TooN/doc/documentation.h?cvsroot=toon&r1=1.31&r2=1.32
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/config.hh?cvsroot=toon&r1=1.11&r2=1.12
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/matrix.hh?cvsroot=toon&r1=1.37&r2=1.38
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/objects.h?cvsroot=toon&r1=1.24&r2=1.25
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/operators.hh?cvsroot=toon&r1=1.42&r2=1.43
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/reference.hh?cvsroot=toon&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/vector.hh?cvsroot=toon&r1=1.48&r2=1.49
Patches:
Index: Doxyfile
===================================================================
RCS file: /cvsroot/toon/TooN/Doxyfile,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- Doxyfile 10 Jul 2009 16:21:49 -0000 1.8
+++ Doxyfile 27 Jul 2009 16:39:42 -0000 1.9
@@ -486,7 +486,7 @@
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
-STRIP_CODE_COMMENTS = YES
+STRIP_CODE_COMMENTS = NO
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
Index: TooN.h
===================================================================
RCS file: /cvsroot/toon/TooN/TooN.h,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -b -r1.49 -r1.50
--- TooN.h 10 Jul 2009 14:05:55 -0000 1.49
+++ TooN.h 27 Jul 2009 16:39:43 -0000 1.50
@@ -70,8 +70,10 @@
#endif
using std::numeric_limits;
- ///Is a number a field? ie, *, -, *, / defined.
+ ///Is a number a field? ie, +, -, *, / defined.
///Specialize this to make TooN work properly with new types.
+ ///@internal
+ ///Internal::Field determines if two classes are in the same field.
///@ingroup gLinAlg
template<class C> struct IsField
{
Index: doc/documentation.h
===================================================================
RCS file: /cvsroot/toon/TooN/doc/documentation.h,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -b -r1.31 -r1.32
--- doc/documentation.h 10 Jul 2009 14:05:55 -0000 1.31
+++ doc/documentation.h 27 Jul 2009 16:39:43 -0000 1.32
@@ -723,7 +723,7 @@
// Modules classifying classes and functions
/// @defgroup gLinAlg Linear Algebra
-/// %Vector and matrix classes, and helpers.
+/// \link TooN::Vector Vector\endlink and \link TooN::Matrix Matrix \endlink
classes, and helpers.
/// @defgroup gDecomps Matrix decompositions
/// Classes to perform matrix decompositions, used to solve
Index: internal/config.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/config.hh,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -b -r1.11 -r1.12
--- internal/config.hh 9 Jun 2009 13:38:11 -0000 1.11
+++ internal/config.hh 27 Jul 2009 16:39:43 -0000 1.12
@@ -0,0 +1 @@
+
Index: internal/matrix.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/matrix.hh,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -b -r1.37 -r1.38
--- internal/matrix.hh 10 Jul 2009 14:10:39 -0000 1.37
+++ internal/matrix.hh 27 Jul 2009 16:39:43 -0000 1.38
@@ -309,12 +309,16 @@
Matrix<2,3> m(d);
double e = m(1,2); // now e = 6.0;
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
const double& operator() (int r, int c) const;
/**
Access an element from the matrix.
@param row_col <code>row_col.first</code> holds the row,
<code>row_col.second</code> holds the column.
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
const double& operator[](const std::pair<int,int>& row_col)
const;
/**
@@ -332,6 +336,8 @@
m(1,2) = 8; // now d = [1 2 3]
// [4 5 8]
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
double& operator() (int r, int c);
@@ -348,6 +354,8 @@
Vector<3> v = m[1]; // now v = [4 5 6];
Vector<2> v2 = m.T()[0]; // now v2 = [1 4];
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
const Vector& operator[] (int r) const;
@@ -366,19 +374,21 @@
m.T()[1] = v; // now m = [0 8 0]
// [4 9 6]
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
Vector& operator[] (int r);
/// How many rows does this matrix have?
+ /// @internal
+ /// This method is not defined by Matrix: it is inherited.
int num_rows() const;
/// How many columns does this matrix have?
+ /// @internal
+ /// This method is not defined by Matrix: it is inherited.
int num_cols() const;
- /// What is the memory layout of this matrix?
- {RowMajor, ColMajor} layout const;
- //@}
-
/// @name Transpose and sub-matrices
//@{
/**
@@ -393,6 +403,8 @@
m.T()[1] = v; // now m = [0 8 0]
// [4 9 6]
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
const Matrix<Cols, Rows>& T() const;
@@ -412,6 +424,8 @@
general, it is not necessary to say <code>M=M.T()</code>,
since you can use
M.T() for free whenever you need the transpose, but if you do
need to, you
have to use the Tranpose() function defined in
<code>helpers.h</code>.
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
Matrix<Cols, Rows>& T();
@@ -425,6 +439,8 @@
Matrix<2> b = m.slice<0,0,2,2>(); // b = [1 2]
// [4 5]
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
template<Rstart, Cstart, Rsize, Csize>
const Matrix<Rsize, Csize>& slice() const;
@@ -439,6 +455,8 @@
Zero(m.slice<0,2,2,1>()); // b = [1 2 0]
// [4 5 0]
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
template<Rstart, Cstart, Rsize, Csize>
Matrix<Rsize, Csize>& slice();
@@ -452,6 +470,8 @@
Extract the top-left 2x2 matrix
Matrix<2> b = m.slice(0,0,2,2);
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
const Matrix<>& slice(int rstart, int cstart, int rsize, int
csize) const;
@@ -463,6 +483,8 @@
Matrix<> m(3,3);
Zero(m.slice(0,0,2,2));
@endcode
+ @internal
+ This method is not defined by Matrix: it is inherited.
*/
Matrix<>& slice(int rstart, int cstart, int rsize, int csize);
Index: internal/objects.h
===================================================================
RCS file: /cvsroot/toon/TooN/internal/objects.h,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -b -r1.24 -r1.25
--- internal/objects.h 10 Jul 2009 16:21:49 -0000 1.24
+++ internal/objects.h 27 Jul 2009 16:39:43 -0000 1.25
@@ -63,6 +63,8 @@
template<class Lhs> Lhs operator+(const Lhs& v, One){return v+1;}
///<Adds One to something
template<class Rhs> Rhs operator-(One, const Rhs& v){return 1-v;}
///<Subtracts something from One
template<class Lhs> Lhs operator-(const Lhs& v, One){return v-1;}
///<Subtracts One from something.
+
+ ///Returns negative One.
inline int operator-(const One&)
{
return -1;
Index: internal/operators.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/operators.hh,v
retrieving revision 1.42
retrieving revision 1.43
diff -u -b -r1.42 -r1.43
--- internal/operators.hh 10 Jul 2009 16:21:49 -0000 1.42
+++ internal/operators.hh 27 Jul 2009 16:39:43 -0000 1.43
@@ -42,8 +42,13 @@
///is not implemented anywhere, the result is used for type deduction.
template<class C> C gettype();
+ ///@internal
+ ///Determine if two classes are in the same field. For the purposes of
+ ///%TooN \c float and \c int are in the same field, since operator
+ ///+,-,*,/ are defined for any combination of \c float and \c int.
template<class L, class R> struct Field
{
+ ///<Set to 1 if the two classes are in the same field.
static const int is = IsField<L>::value && IsField<R>::value;
};
Index: internal/reference.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/reference.hh,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- internal/reference.hh 6 Jul 2009 19:42:33 -0000 1.7
+++ internal/reference.hh 27 Jul 2009 16:39:43 -0000 1.8
@@ -89,7 +89,11 @@
template<int Size, class Precision> inline Vector<Size, Precision,
Reference> wrapVector(Precision* data) { return Vector<Size,
Precision, Reference>(data); }
template<int Size, class Precision> inline const Vector<Size, Precision,
Reference> wrapVector(const Precision* data) { return Vector<Size,
Precision, Reference>(const_cast<Precision*>(data)); }
-
+///Wrap external data as a \link TooN::Matrix Matrix \endlink
+///As usual, if template sizes are provided, then the run-time size is only
+///used if the template size is not Dynamic.
+///@ingroup gLinAlg
+///@{
//Fully static matrices, ie no size parameters
template<int Rows, int Cols> inline Matrix<Rows, Cols,
double, Reference::RowMajor> wrapMatrix(double* data)
{ return Matrix<Rows, Cols, double, Reference::RowMajor>(data);}
template<int Rows, int Cols> inline const Matrix<Rows, Cols,
double, Reference::RowMajor> wrapMatrix(const double* data)
{ return Matrix<Rows, Cols, double,
Reference::RowMajor>(const_cast<double*>(data));}
@@ -105,4 +109,5 @@
inline const Matrix<Dynamic,
Dynamic, double, Reference::RowMajor> wrapMatrix(const double* data, int
rows, int cols) { return Matrix<Dynamic, Dynamic, double,
Reference::RowMajor>(const_cast<double*>(data), rows, cols);}
template<class Precision> inline Matrix<Dynamic,
Dynamic, Precision, Reference::RowMajor> wrapMatrix(Precision* data, int rows,
int cols) { return Matrix<Dynamic, Dynamic, Precision,
Reference::RowMajor>(data, rows, cols);}
template<class Precision> inline const Matrix<Dynamic,
Dynamic, Precision, Reference::RowMajor> wrapMatrix(const Precision* data, int
rows, int cols) { return Matrix<Dynamic, Dynamic, Precision,
Reference::RowMajor>(const_cast<Precision*>(data), rows, cols);}
+///@}
}
Index: internal/vector.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/vector.hh,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -b -r1.48 -r1.49
--- internal/vector.hh 6 May 2009 14:51:18 -0000 1.48
+++ internal/vector.hh 27 Jul 2009 16:39:43 -0000 1.49
@@ -211,9 +211,14 @@
/// Vector<3> v;
/// v[0] = 10;
/// @endcode
+ ///
+ /// @internal
+ /// This method is not defined by Vector: it is inherited.
Precision& operator[] (int i);
- /// access an element of a constant vector
+ /**
+ @overload
+ */
const Precision& operator[] (int i) const;
/// @}
@@ -360,6 +365,8 @@
Vector<3> a = makeVector(1,2,3);
Matrix<1,3> m = a.as_row(); // now m = [1 2 3]
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
Matrix<1, Size, Precision> as_row();
@@ -370,6 +377,8 @@
Vector<3> a = makeVector(1,2,3);
Matrix<3,1> m = a.as_col(); // now m = [1 2 3]'
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
Matrix<Size, 1, Precision> as_col();
@@ -381,6 +390,8 @@
Vector<3> v2 = makeVector(2,3,4);
Vector<3> v3 = v.as_diagonal() * v2; // now v3 = (2,6,12)
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
DiagonalMatrix<Size,Precision> as_diagonal();
@@ -392,6 +403,8 @@
Extract the three elements starting from element 2
Vector<3> b = a.slice<2,3>(); /// b = [3 4 5]
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
template<Start, Length>
const Vector<Length,Precision>& slice() const;
@@ -406,6 +419,8 @@
// replace the two elements starting from element 1 with b
a.slice<1, 2>() = b; /// now a = [1 8 9 4 5]
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
template<Start, Length>
Vector<Length,Precision>& slice();
@@ -419,6 +434,8 @@
Extract the three elements starting from element 2
Vector<> b = a.slice(2,3); /// b = [3 4 5]
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
template<Start, Length>
const Vector<Length,Precision>& slice() const;
@@ -433,6 +450,8 @@
Extract the three elements starting from element 2
a.slice(2,3)[0] = 17; /// a -> [1 2 17 4 5]
@endcode
+ @internal
+ This method is not defined by Vector: it is inherited.
*/
template<Start, Length>
Vector<Length,Precision>& slice();
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Toon-members] TooN Doxyfile TooN.h doc/documentation.h intern...,
Edward Rosten <=