mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-07-09 22:51:51 +08:00
Fix doxy and misc. typos
Found via `codespell -q 3 -I ../eigen-word-whitelist.txt` --- Eigen/src/Core/ProductEvaluators.h | 4 ++-- Eigen/src/Core/arch/GPU/Half.h | 2 +- Eigen/src/Core/util/Memory.h | 2 +- Eigen/src/Geometry/Hyperplane.h | 2 +- Eigen/src/Geometry/Transform.h | 2 +- Eigen/src/Geometry/Translation.h | 12 ++++++------ doc/PreprocessorDirectives.dox | 2 +- doc/TutorialGeometry.dox | 2 +- test/boostmultiprec.cpp | 2 +- test/triangular.cpp | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-)
This commit is contained in:
parent
2cbd9dd498
commit
43fd42a33b
@ -20,7 +20,7 @@ namespace internal {
|
|||||||
/** \internal
|
/** \internal
|
||||||
* Evaluator of a product expression.
|
* Evaluator of a product expression.
|
||||||
* Since products require special treatments to handle all possible cases,
|
* Since products require special treatments to handle all possible cases,
|
||||||
* we simply deffer the evaluation logic to a product_evaluator class
|
* we simply defer the evaluation logic to a product_evaluator class
|
||||||
* which offers more partial specialization possibilities.
|
* which offers more partial specialization possibilities.
|
||||||
*
|
*
|
||||||
* \sa class product_evaluator
|
* \sa class product_evaluator
|
||||||
@ -128,7 +128,7 @@ protected:
|
|||||||
PlainObject m_result;
|
PlainObject m_result;
|
||||||
};
|
};
|
||||||
|
|
||||||
// The following three shortcuts are enabled only if the scalar types match excatly.
|
// The following three shortcuts are enabled only if the scalar types match exactly.
|
||||||
// TODO: we could enable them for different scalar types when the product is not vectorized.
|
// TODO: we could enable them for different scalar types when the product is not vectorized.
|
||||||
|
|
||||||
// Dense = Product
|
// Dense = Product
|
||||||
|
@ -60,7 +60,7 @@ struct __half_raw {
|
|||||||
#if defined(EIGEN_HAS_OLD_HIP_FP16)
|
#if defined(EIGEN_HAS_OLD_HIP_FP16)
|
||||||
// Make a __half_raw definition that is
|
// Make a __half_raw definition that is
|
||||||
// ++ compatible with that of Eigen and
|
// ++ compatible with that of Eigen and
|
||||||
// ++ add a implcit conversion to the native __half of the old HIP implementation.
|
// ++ add an implicit conversion to the native __half of the old HIP implementation.
|
||||||
//
|
//
|
||||||
// Keeping ".x" as "unsigned short" keeps the interface the same between the Eigen and HIP implementation.
|
// Keeping ".x" as "unsigned short" keeps the interface the same between the Eigen and HIP implementation.
|
||||||
//
|
//
|
||||||
|
@ -177,7 +177,7 @@ EIGEN_DEVICE_FUNC inline void* aligned_malloc(std::size_t size)
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
#if EIGEN_DEFAULT_ALIGN_BYTES==16
|
#if EIGEN_DEFAULT_ALIGN_BYTES==16
|
||||||
eigen_assert((size<16 || (std::size_t(result)%16)==0) && "System's malloc returned an unaligned pointer. Compile with EIGEN_MALLOC_ALREADY_ALIGNED=0 to fallback to handmade alignd memory allocator.");
|
eigen_assert((size<16 || (std::size_t(result)%16)==0) && "System's malloc returned an unaligned pointer. Compile with EIGEN_MALLOC_ALREADY_ALIGNED=0 to fallback to handmade aligned memory allocator.");
|
||||||
#endif
|
#endif
|
||||||
#else
|
#else
|
||||||
result = handmade_aligned_malloc(size);
|
result = handmade_aligned_malloc(size);
|
||||||
|
@ -119,7 +119,7 @@ public:
|
|||||||
* If the dimension of the ambient space is greater than 2, then there isn't uniqueness,
|
* If the dimension of the ambient space is greater than 2, then there isn't uniqueness,
|
||||||
* so an arbitrary choice is made.
|
* so an arbitrary choice is made.
|
||||||
*/
|
*/
|
||||||
// FIXME to be consitent with the rest this could be implemented as a static Through function ??
|
// FIXME to be consistent with the rest this could be implemented as a static Through function ??
|
||||||
EIGEN_DEVICE_FUNC explicit Hyperplane(const ParametrizedLine<Scalar, AmbientDimAtCompileTime>& parametrized)
|
EIGEN_DEVICE_FUNC explicit Hyperplane(const ParametrizedLine<Scalar, AmbientDimAtCompileTime>& parametrized)
|
||||||
{
|
{
|
||||||
normal() = parametrized.direction().unitOrthogonal();
|
normal() = parametrized.direction().unitOrthogonal();
|
||||||
|
@ -115,7 +115,7 @@ template<int Mode> struct transform_make_affine;
|
|||||||
* \end{array} \right) \f$
|
* \end{array} \right) \f$
|
||||||
*
|
*
|
||||||
* Note that for a projective transformation the last row can be anything,
|
* Note that for a projective transformation the last row can be anything,
|
||||||
* and then the interpretation of different parts might be sightly different.
|
* and then the interpretation of different parts might be slightly different.
|
||||||
*
|
*
|
||||||
* However, unlike a plain matrix, the Transform class provides many features
|
* However, unlike a plain matrix, the Transform class provides many features
|
||||||
* simplifying both its assembly and usage. In particular, it can be composed
|
* simplifying both its assembly and usage. In particular, it can be composed
|
||||||
|
@ -70,18 +70,18 @@ public:
|
|||||||
/** Constructs and initialize the translation transformation from a vector of translation coefficients */
|
/** Constructs and initialize the translation transformation from a vector of translation coefficients */
|
||||||
EIGEN_DEVICE_FUNC explicit inline Translation(const VectorType& vector) : m_coeffs(vector) {}
|
EIGEN_DEVICE_FUNC explicit inline Translation(const VectorType& vector) : m_coeffs(vector) {}
|
||||||
|
|
||||||
/** \brief Retruns the x-translation by value. **/
|
/** \brief Returns the x-translation by value. **/
|
||||||
EIGEN_DEVICE_FUNC inline Scalar x() const { return m_coeffs.x(); }
|
EIGEN_DEVICE_FUNC inline Scalar x() const { return m_coeffs.x(); }
|
||||||
/** \brief Retruns the y-translation by value. **/
|
/** \brief Returns the y-translation by value. **/
|
||||||
EIGEN_DEVICE_FUNC inline Scalar y() const { return m_coeffs.y(); }
|
EIGEN_DEVICE_FUNC inline Scalar y() const { return m_coeffs.y(); }
|
||||||
/** \brief Retruns the z-translation by value. **/
|
/** \brief Returns the z-translation by value. **/
|
||||||
EIGEN_DEVICE_FUNC inline Scalar z() const { return m_coeffs.z(); }
|
EIGEN_DEVICE_FUNC inline Scalar z() const { return m_coeffs.z(); }
|
||||||
|
|
||||||
/** \brief Retruns the x-translation as a reference. **/
|
/** \brief Returns the x-translation as a reference. **/
|
||||||
EIGEN_DEVICE_FUNC inline Scalar& x() { return m_coeffs.x(); }
|
EIGEN_DEVICE_FUNC inline Scalar& x() { return m_coeffs.x(); }
|
||||||
/** \brief Retruns the y-translation as a reference. **/
|
/** \brief Returns the y-translation as a reference. **/
|
||||||
EIGEN_DEVICE_FUNC inline Scalar& y() { return m_coeffs.y(); }
|
EIGEN_DEVICE_FUNC inline Scalar& y() { return m_coeffs.y(); }
|
||||||
/** \brief Retruns the z-translation as a reference. **/
|
/** \brief Returns the z-translation as a reference. **/
|
||||||
EIGEN_DEVICE_FUNC inline Scalar& z() { return m_coeffs.z(); }
|
EIGEN_DEVICE_FUNC inline Scalar& z() { return m_coeffs.z(); }
|
||||||
|
|
||||||
EIGEN_DEVICE_FUNC const VectorType& vector() const { return m_coeffs; }
|
EIGEN_DEVICE_FUNC const VectorType& vector() const { return m_coeffs; }
|
||||||
|
@ -66,7 +66,7 @@ functions by defining EIGEN_HAS_C99_MATH=1.
|
|||||||
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
||||||
- \b EIGEN_HAS_CXX11_MATH - controls the implementation of some functions such as round, logp1, isinf, isnan, etc.
|
- \b EIGEN_HAS_CXX11_MATH - controls the implementation of some functions such as round, logp1, isinf, isnan, etc.
|
||||||
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
||||||
- \b EIGEN_HAS_RVALUE_REFERENCES - defines whetehr rvalue references are supported
|
- \b EIGEN_HAS_RVALUE_REFERENCES - defines whether rvalue references are supported
|
||||||
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
||||||
- \b EIGEN_HAS_STD_RESULT_OF - defines whether std::result_of is supported
|
- \b EIGEN_HAS_STD_RESULT_OF - defines whether std::result_of is supported
|
||||||
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
Automatic detection disabled if EIGEN_MAX_CPP_VER<11.
|
||||||
|
@ -111,7 +111,7 @@ rot3 = rot1.slerp(alpha,rot2);\endcode</td></tr>
|
|||||||
|
|
||||||
|
|
||||||
<a href="#" class="top">top</a>\section TutorialGeoTransform Affine transformations
|
<a href="#" class="top">top</a>\section TutorialGeoTransform Affine transformations
|
||||||
Generic affine transformations are represented by the Transform class which internaly
|
Generic affine transformations are represented by the Transform class which internally
|
||||||
is a (Dim+1)^2 matrix. In Eigen we have chosen to not distinghish between points and
|
is a (Dim+1)^2 matrix. In Eigen we have chosen to not distinghish between points and
|
||||||
vectors such that all points are actually represented by displacement vectors from the
|
vectors such that all points are actually represented by displacement vectors from the
|
||||||
origin ( \f$ \mathbf{p} \equiv \mathbf{p}-0 \f$ ). With that in mind, real points and
|
origin ( \f$ \mathbf{p} \equiv \mathbf{p}-0 \f$ ). With that in mind, real points and
|
||||||
|
@ -156,7 +156,7 @@ EIGEN_DECLARE_TEST(boostmultiprec)
|
|||||||
std::cout << "NumTraits<Real>::highest() = " << NumTraits<Real>::highest() << std::endl;
|
std::cout << "NumTraits<Real>::highest() = " << NumTraits<Real>::highest() << std::endl;
|
||||||
std::cout << "NumTraits<Real>::digits10() = " << NumTraits<Real>::digits10() << std::endl;
|
std::cout << "NumTraits<Real>::digits10() = " << NumTraits<Real>::digits10() << std::endl;
|
||||||
|
|
||||||
// chekc stream output
|
// check stream output
|
||||||
{
|
{
|
||||||
Mat A(10,10);
|
Mat A(10,10);
|
||||||
A.setRandom();
|
A.setRandom();
|
||||||
|
@ -68,7 +68,7 @@ template<typename MatrixType> void triangular_square(const MatrixType& m)
|
|||||||
while (numext::abs2(m1(i,i))<RealScalar(1e-1)) m1(i,i) = internal::random<Scalar>();
|
while (numext::abs2(m1(i,i))<RealScalar(1e-1)) m1(i,i) = internal::random<Scalar>();
|
||||||
|
|
||||||
Transpose<MatrixType> trm4(m4);
|
Transpose<MatrixType> trm4(m4);
|
||||||
// test back and forward subsitution with a vector as the rhs
|
// test back and forward substitution with a vector as the rhs
|
||||||
m3 = m1.template triangularView<Upper>();
|
m3 = m1.template triangularView<Upper>();
|
||||||
VERIFY(v2.isApprox(m3.adjoint() * (m1.adjoint().template triangularView<Lower>().solve(v2)), largerEps));
|
VERIFY(v2.isApprox(m3.adjoint() * (m1.adjoint().template triangularView<Lower>().solve(v2)), largerEps));
|
||||||
m3 = m1.template triangularView<Lower>();
|
m3 = m1.template triangularView<Lower>();
|
||||||
|
Loading…
x
Reference in New Issue
Block a user