GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-09-23 06:43:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

mark the packet access methods as internal

Browse Source
This commit is contained in:
Gael Guennebaud 2011-02-01 16:14:53 +01:00
parent a486d5590a
commit ffc8386fdb
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Eigen/src/Core/DenseCoeffsBase.h
View File

@ -207,7 +207,8 @@ class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived>
EIGEN_STRONG_INLINE CoeffReturnType EIGEN_STRONG_INLINE CoeffReturnType
w() const { return (*this)[3]; } w() const { return (*this)[3]; }
/** \returns the packet of coefficients starting at the given row and column. It is your responsibility /** \internal
* \returns the packet of coefficients starting at the given row and column. It is your responsibility
* to ensure that a packet really starts there. This method is only available on expressions having the * to ensure that a packet really starts there. This method is only available on expressions having the
* PacketAccessBit. * PacketAccessBit.
* *
@ -225,6 +226,7 @@ class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived>
} }
/** \internal */
template<int LoadMode> template<int LoadMode>
EIGEN_STRONG_INLINE PacketReturnType packetByOuterInner(Index outer, Index inner) const EIGEN_STRONG_INLINE PacketReturnType packetByOuterInner(Index outer, Index inner) const
{ {
@ -232,7 +234,8 @@ class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived>
colIndexByOuterInner(outer, inner)); colIndexByOuterInner(outer, inner));
} }
/** \returns the packet of coefficients starting at the given index. It is your responsibility /** \internal
* \returns the packet of coefficients starting at the given index. It is your responsibility
* to ensure that a packet really starts there. This method is only available on expressions having the * to ensure that a packet really starts there. This method is only available on expressions having the
* PacketAccessBit and the LinearAccessBit. * PacketAccessBit and the LinearAccessBit.
* *
@ -425,7 +428,8 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived,
EIGEN_STRONG_INLINE Scalar& EIGEN_STRONG_INLINE Scalar&
w() { return (*this)[3]; } w() { return (*this)[3]; }
/** Stores the given packet of coefficients, at the given row and column of this expression. It is your responsibility /** \internal
* Stores the given packet of coefficients, at the given row and column of this expression. It is your responsibility
* to ensure that a packet really starts there. This method is only available on expressions having the * to ensure that a packet really starts there. This method is only available on expressions having the
* PacketAccessBit. * PacketAccessBit.
* *
@ -444,6 +448,7 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived,
} }
/** \internal */
template<int StoreMode> template<int StoreMode>
EIGEN_STRONG_INLINE void writePacketByOuterInner EIGEN_STRONG_INLINE void writePacketByOuterInner
(Index outer, Index inner, const typename internal::packet_traits<Scalar>::type& x) (Index outer, Index inner, const typename internal::packet_traits<Scalar>::type& x)
@ -453,7 +458,8 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived,
x); x);
} }
/** Stores the given packet of coefficients, at the given index in this expression. It is your responsibility /** \internal
* Stores the given packet of coefficients, at the given index in this expression. It is your responsibility
* to ensure that a packet really starts there. This method is only available on expressions having the * to ensure that a packet really starts there. This method is only available on expressions having the
* PacketAccessBit and the LinearAccessBit. * PacketAccessBit and the LinearAccessBit.
* *
@ -461,7 +467,6 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived,
* the appropriate vectorization instruction. Aligned access is faster, but is only possible for packets * the appropriate vectorization instruction. Aligned access is faster, but is only possible for packets
* starting at an address which is a multiple of the packet size. * starting at an address which is a multiple of the packet size.
*/ */
template<int StoreMode> template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket EIGEN_STRONG_INLINE void writePacket
(Index index, const typename internal::packet_traits<Scalar>::type& x) (Index index, const typename internal::packet_traits<Scalar>::type& x)
@ -546,6 +551,7 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived,
other.derived().template packet<LoadMode>(index)); other.derived().template packet<LoadMode>(index));
} }
/** \internal */
template<typename OtherDerived, int StoreMode, int LoadMode> template<typename OtherDerived, int StoreMode, int LoadMode>
EIGEN_STRONG_INLINE void copyPacketByOuterInner(Index outer, Index inner, const DenseBase<OtherDerived>& other) EIGEN_STRONG_INLINE void copyPacketByOuterInner(Index outer, Index inner, const DenseBase<OtherDerived>& other)
{ {

4
Eigen/src/Core/PlainObjectBase.h
View File

@ -129,6 +129,7 @@ class PlainObjectBase : public internal::dense_xpr_base<Derived>::type
return m_storage.data()[index]; return m_storage.data()[index];
} }
/** \internal */
template<int LoadMode> template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet(Index row, Index col) const EIGEN_STRONG_INLINE PacketScalar packet(Index row, Index col) const
{ {
@ -138,12 +139,14 @@ class PlainObjectBase : public internal::dense_xpr_base<Derived>::type
: row + col * m_storage.rows())); : row + col * m_storage.rows()));
} }
/** \internal */
template<int LoadMode> template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet(Index index) const EIGEN_STRONG_INLINE PacketScalar packet(Index index) const
{ {
return internal::ploadt<PacketScalar, LoadMode>(m_storage.data() + index); return internal::ploadt<PacketScalar, LoadMode>(m_storage.data() + index);
} }
/** \internal */
template<int StoreMode> template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket(Index row, Index col, const PacketScalar& x) EIGEN_STRONG_INLINE void writePacket(Index row, Index col, const PacketScalar& x)
{ {
@ -153,6 +156,7 @@ class PlainObjectBase : public internal::dense_xpr_base<Derived>::type
: row + col * m_storage.rows()), x); : row + col * m_storage.rows()), x);
} }
/** \internal */
template<int StoreMode> template<int StoreMode>
EIGEN_STRONG_INLINE void writePacket(Index index, const PacketScalar& x) EIGEN_STRONG_INLINE void writePacket(Index index, const PacketScalar& x)
{ {