aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core/NumTraits.h
diff options
context:
space:
mode:
authorGravatar Rafael Guglielmetti <register@rgug.ch>2016-12-16 09:07:12 +0000
committerGravatar Rafael Guglielmetti <register@rgug.ch>2016-12-16 09:07:12 +0000
commit8f11df266713eb642f046006a7851f5100f107e3 (patch)
tree6e2c6a41eac1ace8b214f6dfcc0c05748a205dfc /Eigen/src/Core/NumTraits.h
parent7d5303a083c93f1a04b09aaa6fd35481315b043e (diff)
NumTraits.h:
For the values 'ReadCost, AddCost and MulCost', information about value Eigen::HugeCost
Diffstat (limited to 'Eigen/src/Core/NumTraits.h')
-rw-r--r--Eigen/src/Core/NumTraits.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/Eigen/src/Core/NumTraits.h b/Eigen/src/Core/NumTraits.h
index dd61195bc..aebc0c259 100644
--- a/Eigen/src/Core/NumTraits.h
+++ b/Eigen/src/Core/NumTraits.h
@@ -71,7 +71,7 @@ struct default_digits10_impl<T,false,true> // Integer
* and to \c 0 otherwise.
* \li Enum values ReadCost, AddCost and MulCost representing a rough estimate of the number of CPU cycles needed
* to by move / add / mul instructions respectively, assuming the data is already stored in CPU registers.
- * Stay vague here. No need to do architecture-specific stuff.
+ * Stay vague here. No need to do architecture-specific stuff. If you don't know what this means, just use \c Eigen::HugeCost.
* \li An enum value \a IsSigned. It is equal to \c 1 if \a T is a signed type and to 0 if \a T is unsigned.
* \li An enum value \a RequireInitialization. It is equal to \c 1 if the constructor of the numeric type \a T must
* be called, and to 0 if it is safe not to call it. Default is 0 if \a T is an arithmetic type, and 1 otherwise.