[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Toon-members] TooN Doxyfile helpers.h internal/debug.hh inter...
From: |
Edward Rosten |
Subject: |
[Toon-members] TooN Doxyfile helpers.h internal/debug.hh inter... |
Date: |
Fri, 10 Jul 2009 16:21:49 +0000 |
CVSROOT: /cvsroot/toon
Module name: TooN
Changes by: Edward Rosten <edrosten> 09/07/10 16:21:49
Modified files:
. : Doxyfile helpers.h
internal : debug.hh objects.h operators.hh
Log message:
More docs
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/TooN/Doxyfile?cvsroot=toon&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/TooN/helpers.h?cvsroot=toon&r1=1.77&r2=1.78
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/debug.hh?cvsroot=toon&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/objects.h?cvsroot=toon&r1=1.23&r2=1.24
http://cvs.savannah.gnu.org/viewcvs/TooN/internal/operators.hh?cvsroot=toon&r1=1.41&r2=1.42
Patches:
Index: Doxyfile
===================================================================
RCS file: /cvsroot/toon/TooN/Doxyfile,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- Doxyfile 10 Jul 2009 14:05:55 -0000 1.7
+++ Doxyfile 10 Jul 2009 16:21:49 -0000 1.8
@@ -245,7 +245,7 @@
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
-INTERNAL_DOCS = NO
+INTERNAL_DOCS = YES
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
Index: helpers.h
===================================================================
RCS file: /cvsroot/toon/TooN/helpers.h,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
--- helpers.h 29 Jun 2009 13:04:00 -0000 1.77
+++ helpers.h 10 Jul 2009 16:21:49 -0000 1.78
@@ -226,6 +226,9 @@
}
namespace Internal {
+ ///@internal
+ ///@brief Exponentiate a matrix using a the Taylor series
+ ///This will not work if the norm of the matrix is too large.
template <int R, int C, typename P, typename B>
inline Matrix<R, C, P> exp_taylor( const Matrix<R,C,P,B> & m ){
TooN::SizeMismatch<R, C>::test(m.num_rows(),
m.num_cols());
Index: internal/debug.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/debug.hh,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- internal/debug.hh 29 Apr 2009 21:56:54 -0000 1.6
+++ internal/debug.hh 10 Jul 2009 16:21:49 -0000 1.7
@@ -19,6 +19,9 @@
}
}
#else
+ ///@internal
+ ///Function used to check bounds.
+ ///By default it does nothing. See \ref sDebug.
static inline void check_index(int, int){}
#endif
@@ -91,6 +94,9 @@
}
}
#else
+ ///@internal
+ ///@brief This function is called on any uninitialized data. By
default, no action is taken.
+ ///See \ref sDebug
template<class P> static void debug_initialize(P*, int)
{
}
Index: internal/objects.h
===================================================================
RCS file: /cvsroot/toon/TooN/internal/objects.h,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -b -r1.23 -r1.24
--- internal/objects.h 10 Jul 2009 14:05:56 -0000 1.23
+++ internal/objects.h 10 Jul 2009 16:21:49 -0000 1.24
@@ -57,12 +57,12 @@
return 1;
}
};
- template<class Rhs> Rhs operator*(One, const Rhs& v){return v;}
- template<class Lhs> Lhs operator*(const Lhs& v, One){return v;}
- template<class Rhs> Rhs operator+(One, const Rhs& v){return 1+v;}
- template<class Lhs> Lhs operator+(const Lhs& v, One){return v+1;}
- template<class Rhs> Rhs operator-(One, const Rhs& v){return 1-v;}
- template<class Lhs> Lhs operator-(const Lhs& v, One){return v-1;}
+ template<class Rhs> Rhs operator*(One, const Rhs& v){return v;}
///<Multiplies One by something.
+ template<class Lhs> Lhs operator*(const Lhs& v, One){return v;}
///<Multiplies something by One
+ template<class Rhs> Rhs operator+(One, const Rhs& v){return 1+v;}
///<Adds something to One
+ 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.
inline int operator-(const One&)
{
return -1;
Index: internal/operators.hh
===================================================================
RCS file: /cvsroot/toon/TooN/internal/operators.hh,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -b -r1.41 -r1.42
--- internal/operators.hh 5 May 2009 16:26:38 -0000 1.41
+++ internal/operators.hh 10 Jul 2009 16:21:49 -0000 1.42
@@ -37,6 +37,9 @@
namespace Internal {
//Automatic type deduction of return types
+ ///@internal
+ ///This function offers to return a value of type C. This function
+ ///is not implemented anywhere, the result is used for type deduction.
template<class C> C gettype();
template<class L, class R> struct Field
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Toon-members] TooN Doxyfile helpers.h internal/debug.hh inter...,
Edward Rosten <=