devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix all the doxygen warnings.

Browse Source
This commit is contained in:
Antonio Sánchez
2025-02-01 00:00:31 +00:00
parent 9589cc4e7f
commit b1e74b1ccd
85 changed files with 829 additions and 2782 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
unsupported/Eigen/src/BVH/KdBVH.h
View File

@@ -55,20 +55,20 @@ struct get_boxes_helper<ObjectList, VolumeList, int> {
*
* \param Scalar_ The underlying scalar type of the bounding boxes
* \param Dim_ The dimension of the space in which the hierarchy lives
* \param _Object The object type that lives in the hierarchy. It must have value semantics. Either
* bounding_box(_Object) must be defined and return an AlignedBox<Scalar_, Dim_> or bounding boxes must be provided to
* the tree initializer.
* \param Object_ The object type that lives in the hierarchy. It must have value semantics. Either
* `bounding_box(Object_)` must be defined and return an `AlignedBox<Scalar_, Dim_>` or bounding boxes
* must be provided to the tree initializer.
*
* This class provides a simple (as opposed to optimized) implementation of a bounding volume hierarchy analogous to a
* This class provides a simple (as opposed to optimized) implementation of a bounding volume hierarchy analogous to a
* Kd-tree. Given a sequence of objects, it computes their bounding boxes, constructs a Kd-tree of their centers and
* builds a BVH with the structure of that Kd-tree. When the elements of the tree are too expensive to be copied
* around, it is useful for _Object to be a pointer.
* around, it is useful for `Object_` to be a pointer.
*/
template <typename Scalar_, int Dim_, typename _Object>
template <typename Scalar_, int Dim_, typename Object_>
class KdBVH {
public:
enum { Dim = Dim_ };
typedef _Object Object;
typedef Object_ Object;
typedef std::vector<Object, aligned_allocator<Object> > ObjectList;
typedef Scalar_ Scalar;
typedef AlignedBox<Scalar, Dim> Volume;

10
unsupported/Eigen/src/EulerAngles/EulerAngles.h
View File

@@ -315,6 +315,16 @@ class EulerAngles : public RotationBase<EulerAngles<Scalar_, _System>, 3> {
EIGEN_EULER_ANGLES_TYPEDEFS(float, f)
EIGEN_EULER_ANGLES_TYPEDEFS(double, d)
// Specifically-referenced instantiations.
/** \typedef EulerAnglesXYZd
* \ingroup EulerAngles_Module
* Euler XYZ system with type double entries.
*/
/** \typedef EulerAnglesZYZf
* \ingroup EulerAngles_Module
* Euler ZYZ system with type float entries.
*/
namespace internal {
template <typename Scalar_, class _System>
struct traits<EulerAngles<Scalar_, _System> > {

7
unsupported/Eigen/src/EulerAngles/EulerSystem.h
View File

@@ -260,10 +260,11 @@ class EulerSystem {
friend struct internal::eulerangles_assign_impl;
};
#define EIGEN_EULER_SYSTEM_TYPEDEF(A, B, C) \
/** \ingroup EulerAngles_Module */ \
typedef EulerSystem<EULER_##A, EULER_##B, EULER_##C> EulerSystem##A##B##C;
#define EIGEN_EULER_SYSTEM_TYPEDEF(A, B, C) typedef EulerSystem<EULER_##A, EULER_##B, EULER_##C> EulerSystem##A##B##C;
/** Default XYZ Euler coordinate system.
* \ingroup EulerAngles_Module
*/
EIGEN_EULER_SYSTEM_TYPEDEF(X, Y, Z)
EIGEN_EULER_SYSTEM_TYPEDEF(X, Y, X)
EIGEN_EULER_SYSTEM_TYPEDEF(X, Z, Y)

2
unsupported/Eigen/src/IterativeSolvers/Scaling.h
View File

@@ -16,7 +16,7 @@
namespace Eigen {
/**
* \ingroup IterativeSolvers_Module
* \ingroup IterativeLinearSolvers_Module
* \brief iterative scaling algorithm to equilibrate rows and column norms in matrices
*
* This class can be used as a preprocessing tool to accelerate the convergence of iterative methods