mirror of
https://gitlab.com/libeigen/eigen.git
synced 2024-12-27 07:29:52 +08:00
172000aaeb
Documentation: * add an overview for each module. * add an example for .all() and Cwise::operator<
34 lines
982 B
Plaintext
34 lines
982 B
Plaintext
#ifndef EIGEN_ARRAY_MODULE_H
|
|
#define EIGEN_ARRAY_MODULE_H
|
|
|
|
#include "Core"
|
|
|
|
namespace Eigen {
|
|
|
|
/** \defgroup Array Array module
|
|
* This module provides several handy features to manipulate matrices as simple array of values.
|
|
* In addition to listed classes, it defines various methods of the Cwise interface
|
|
* (accessible from MatrixBase::cwise()), including:
|
|
* - matrix-scalar sum,
|
|
* - coeff-wise comparison operators,
|
|
* - sin, cos, sqrt, pow, exp, log, square, cube, reciprocal.
|
|
*
|
|
* This module also provides various MatrixBase methods, including:
|
|
* - \ref MatrixBase::all() "all", \ref MatrixBase::any() "any",
|
|
* - \ref MatrixBase::Random() "random matrix initialization"
|
|
*
|
|
* \code
|
|
* #include <Eigen/Array>
|
|
* \endcode
|
|
*/
|
|
|
|
#include "src/Array/CwiseOperators.h"
|
|
#include "src/Array/Functors.h"
|
|
#include "src/Array/AllAndAny.h"
|
|
#include "src/Array/PartialRedux.h"
|
|
#include "src/Array/Random.h"
|
|
|
|
} // namespace Eigen
|
|
|
|
#endif // EIGEN_ARRAY_MODULE_H
|