Clarify the meaning of AlignedBit (bug #359)

This commit is contained in:
Gael Guennebaud 2013-10-28 17:44:07 +01:00
parent 2e606394b1
commit d3e84b747a

View File

@ -143,7 +143,14 @@ const unsigned int DirectAccessBit = 0x40;
/** \ingroup flags
*
* means the first coefficient packet is guaranteed to be aligned */
* means the first coefficient packet is guaranteed to be aligned.
* An expression cannot has the AlignedBit without the PacketAccessBit flag.
* In other words, this means we are allow to perform an aligned packet access to the first element regardless
* of the expression kind:
* \code
* expression.packet<Aligned>(0);
* \endcode
*/
const unsigned int AlignedBit = 0x80;
const unsigned int NestByRefBit = 0x100;