Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
BadSlice< 0 >A static slice is OK. This class is used after it has been determined that a slice is OK. It does nothing except provide a callable function. By contrast, if the slice is not OK, then the class is not specified and the function is therefore not callable, and a compile error results
CentralCrossDifferenceSecond< Functor, Precision, Size, Base >Functor wrapper for computing finite difference cross derivatives along a pair of axes
CentralDifferenceGradient< Functor, Precision, Size, Base >Functor wrapper for computing finite differences along an axis
CentralDifferenceSecond< Functor, Precision, Size, Base >Functor wrapper for computing finite difference second derivatives along an axis
CheckSlice< Size, Start, Length >Check if a slice is OK. This class is used to see if a slice is OK. It provides a callable function which checks the run-time slice information. If the compile time information is bad, then it will not compile at all. Otherwise, the sizes are checked at run-time. The check will be optimized away if the sizes are known statically
Cholesky< Size, Precision >Decomposes a positive-semidefinite symmetric matrix A (such as a covariance) into L*D*L^T, where L is lower-triangular and D is diagonal
ColSizeHolder< S >
ComputeSymEigen< Size >Compute eigensystems for sizes > 2 Helper struct for computing eigensystems, to allow for specialization on 2x2 matrices
ComputeSymEigen< 2 >Compute 2x2 eigensystems Helper struct for computing eigensystems, specialized on 2x2 matrices
ConjugateGradient< Size, Precision >This class provides a nonlinear conjugate-gradient optimizer
DiagonalMatrix< Size, Precision, Base >A diagonal matrix
DownhillSimplex< N, Precision >This is an implementation of the Downhill Simplex (Nelder & Mead, 1965) algorithm
DynamicEndMarkerUsed to mark slice to some offset before the end of a vector. The offset is known at run time
Field< L, R >
Field< Lhs, One >Does One behave as a field with respect to Lhs?
Field< One, Rhs >Does One behave as a field with respect to Rhs?
GR_SVD< M, N, Precision, WANT_U, WANT_V >Performs SVD and back substitute to solve equations
ILinear< Precision >A reweighting class representing no reweighting in IRLS
IRLS< Size, Precision, Reweight >Performs iterative reweighted least squares
IsField< C >Is a number a field? ie, +, -, *, / defined
Lapack_Cholesky< Size, Precision >Decomposes a positive-semidefinite symmetric matrix A (such as a covariance) into L*L^T, where L is lower-triangular
LineSearch< Size, Precision, Func >Turn a multidimensional function in to a 1D function by specifying a point and direction
LU< Size, Precision >Performs LU decomposition and back substitutes to solve equations
Matrix< Rows, Cols, Precision, Layout >A matrix
N< Num >Choose a number statically or dynamically
NegType< C >For an instance i of type C, what is the type of -i? Usually the answer is that is it the same type
NegType< One >The type of -One
OneThis class represents 1 and only in all its forms
Operator< T >This is a struct used heavily in TooN internals
Operator< Internal::AddIdentity< R, C, P, B, Precision > >Operator to construct a new matrix with idendity added
Operator< Internal::Data< N, P > >Object which fills a matrix some data. There is no size known, since the size of the data is known at compile time. Therefore if the size of the matrix is not known, then something deeply strange is going on
Operator< Internal::Identity< Pr > >Object which behaves like an Identity matrix. See TooN::Identity
Operator< Internal::RCScalars< P > >Variant of Scalars (see TooN::Ones) which holds two sizes to construct dynamic matrices
Operator< Internal::RCZero >Variant of the Zeros object which holds two sizes for constructing dynamic matrices
Operator< Internal::Scalars< P > >Generic scalars object. Knows how to be added, knows how to deal with += and so on. See TooN::Ones
Operator< Internal::ScalarsMatrix< R, C, P, B, Precision > >Operator to construct a new matrix a a matrix with a scalar added to every element
Operator< Internal::ScalarsVector< S, P, B, Precision > >Operator to construct a new vector a a vector with a scalar added to every element
Operator< Internal::SizedIdentity< Precision > >A variant of Identity which holds a size, allowing dynamic matrices to be constructed
Operator< Internal::SizedScalars< P > >Variant of the Operator<Internal::Scalars> object which holds a size to construct dynamic vectors or square matrices
Operator< Internal::SizedZero >Variant of the Zeros object which holds a size for constructing dynamic vectors
Operator< Internal::Zero >Object which behaves like a block of zeros. See TooN::Zeros
RobustI< Precision >Robust reweighting (type I) for IRLS
RobustII< Precision >Robust reweighting (type II) for IRLS
RobustIII< Precision >A reweighting class where the objective function tends to a fixed value, rather than infinity
RowSizeHolder< S >
SE2< Precision >Represent a two-dimensional Euclidean transformation (a rotation and a translation)
SE3< Precision >Represent a three-dimensional Euclidean transformation (a rotation and a translation)
SizeHolder< s >This struct holds a size using no data for static sizes. This struct holds a size is the size is dynamic, or simply recorcs the number in the type system if the size is static
SizeHolder<-1 >This struct holds a size integer for dynamic sizes
SL< N, Precision >Element from the group SL(n), the NxN matrices M with det(M) = 1
SlicingA tag used to indicate that a slice is being constructed
SO2< Precision >Class to represent a two-dimensional rotation matrix
SO3< Precision >Class to represent a three-dimensional rotation matrix
SQSVD< Size, Precision >Version of SVD forced to be square princiapally here to allow use in WLS
Square< R, C >Provides the static size for a square matrix. In the general case, if R != C, then the matrix is not square and so no size is provided. A compile error results
Square< Dynamic, C >Provides the static size for a square matrix where one dimension is static. The size must be equal to the size of the static dimension
Square< Dynamic, Dynamic >Provides the static size for a square matrix where both dimensions are dynamic. The size must be Dynamic
Square< R, Dynamic >Provides the static size for a square matrix where one dimension is static. The size must be equal to the size of the static dimension
Square< R, R >Provides the static size for a square matrix where both dimensions are the same
StaticEndMarker< I >Used to mark slice to some offset before the end of a vector. The offset is known at compile time
StaticSizedAllocator< Size, Precision >This allocator object sets aside memory for a statically sized object. It will put all the data on the stack if there are less then TooN::max_bytes_on_stack of data, otherwise it will use new/delete
SVD< Rows, Cols, Precision >Performs SVD and back substitute to solve equations
SymEigen< Size, Precision >Performs eigen decomposition of a matrix
Vector< Size, Precision, Base >A vector
VectorAlloc< Size, Precision >Allocate memory for a Vector
WLS< Size, Precision, Decomposition >Performs Gauss-Newton weighted least squares computation

Generated on Tue Oct 27 16:09:25 2009 for TooN by  doxygen 1.5.9