11#ifndef EIGEN_PERMUTATIONMATRIX_H
12#define EIGEN_PERMUTATIONMATRIX_H
18enum PermPermProduct_t {PermPermProduct};
45template<
typename Derived>
48 typedef internal::traits<Derived> Traits;
52 #ifndef EIGEN_PARSED_BY_DOXYGEN
53 typedef typename Traits::IndicesType IndicesType;
55 Flags = Traits::Flags,
56 RowsAtCompileTime = Traits::RowsAtCompileTime,
57 ColsAtCompileTime = Traits::ColsAtCompileTime,
58 MaxRowsAtCompileTime = Traits::MaxRowsAtCompileTime,
59 MaxColsAtCompileTime = Traits::MaxColsAtCompileTime
61 typedef typename Traits::StorageIndex StorageIndex;
66 typedef PlainPermutationType PlainObject;
73 template<
typename OtherDerived>
81 template<
typename OtherDerived>
82 Derived&
operator=(
const TranspositionsBase<OtherDerived>& tr)
99 #ifndef EIGEN_PARSED_BY_DOXYGEN
100 template<
typename DenseDerived>
105 other.
coeffRef(
indices().coeff(i),i) =
typename DenseDerived::Scalar(1);
133 StorageIndex n = StorageIndex(
size());
134 for(StorageIndex i = 0; i < n; ++i)
157 eigen_assert(i>=0 && j>=0 && i<
size() && j<
size());
160 if(
indices().coeff(k) == i)
indices().coeffRef(k) = StorageIndex(j);
161 else if(
indices().coeff(k) == j)
indices().coeffRef(k) = StorageIndex(i);
176 eigen_assert(i>=0 && j>=0 && i<
size() && j<
size());
186 {
return InverseReturnType(
derived()); }
192 {
return InverseReturnType(
derived()); }
197#ifndef EIGEN_PARSED_BY_DOXYGEN
199 template<
typename OtherDerived>
204 template<
typename Lhs,
typename Rhs>
205 void assignProduct(
const Lhs& lhs,
const Rhs& rhs)
207 eigen_assert(lhs.cols() == rhs.rows());
208 for (
Index i=0; i<
rows();++i)
indices().coeffRef(i) = lhs.indices().coeff(rhs.indices().coeff(i));
218 template<
typename Other>
220 {
return PlainPermutationType(internal::PermPermProduct,
derived(), other.
derived()); }
226 template<
typename Other>
227 inline PlainPermutationType
operator*(
const InverseImpl<Other,PermutationStorage>& other)
const
228 {
return PlainPermutationType(internal::PermPermProduct, *
this, other.eval()); }
234 template<
typename Other>
friend
236 {
return PlainPermutationType(internal::PermPermProduct, other.eval(), perm); }
252 while(r<n && mask[r]) r++;
272template<
int SizeAtCompileTime,
int MaxSizeAtCompileTime,
typename _StorageIndex>
273struct traits<PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex> >
274 : traits<Matrix<_StorageIndex,SizeAtCompileTime,SizeAtCompileTime,0,MaxSizeAtCompileTime,MaxSizeAtCompileTime> >
276 typedef PermutationStorage StorageKind;
277 typedef Matrix<_StorageIndex, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1> IndicesType;
278 typedef _StorageIndex StorageIndex;
296template<
int SizeAtCompileTime,
int MaxSizeAtCompileTime,
typename _StorageIndex>
300 typedef internal::traits<PermutationMatrix> Traits;
305 #ifndef EIGEN_PARSED_BY_DOXYGEN
306 typedef typename Traits::IndicesType IndicesType;
307 typedef typename Traits::StorageIndex StorageIndex;
321 template<
typename OtherDerived>
323 : m_indices(other.
indices()) {}
332 template<
typename Other>
337 template<
typename Other>
339 : m_indices(tr.
size())
345 template<
typename Other>
353 template<
typename Other>
360 const IndicesType&
indices()
const {
return m_indices; }
367#ifndef EIGEN_PARSED_BY_DOXYGEN
368 template<
typename Other>
370 : m_indices(other.
derived().nestedExpression().
size())
373 StorageIndex end = StorageIndex(m_indices.size());
374 for (StorageIndex i=0; i<end;++i)
375 m_indices.coeffRef(other.derived().nestedExpression().indices().coeff(i)) = i;
377 template<
typename Lhs,
typename Rhs>
378 PermutationMatrix(internal::PermPermProduct_t,
const Lhs& lhs,
const Rhs& rhs)
381 Base::assignProduct(lhs,rhs);
387 IndicesType m_indices;
392template<
int SizeAtCompileTime,
int MaxSizeAtCompileTime,
typename _StorageIndex,
int _PacketAccess>
393struct traits<Map<PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex>,_PacketAccess> >
394 : traits<Matrix<_StorageIndex,SizeAtCompileTime,SizeAtCompileTime,0,MaxSizeAtCompileTime,MaxSizeAtCompileTime> >
396 typedef PermutationStorage StorageKind;
397 typedef Map<const Matrix<_StorageIndex, SizeAtCompileTime, 1, 0, MaxSizeAtCompileTime, 1>, _PacketAccess> IndicesType;
398 typedef _StorageIndex StorageIndex;
403template<
int SizeAtCompileTime,
int MaxSizeAtCompileTime,
typename _StorageIndex,
int _PacketAccess>
404class Map<PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex>,_PacketAccess>
405 :
public PermutationBase<Map<PermutationMatrix<SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex>,_PacketAccess> >
407 typedef PermutationBase<Map> Base;
408 typedef internal::traits<Map> Traits;
411 #ifndef EIGEN_PARSED_BY_DOXYGEN
412 typedef typename Traits::IndicesType IndicesType;
413 typedef typename IndicesType::Scalar StorageIndex;
416 inline Map(
const StorageIndex* indicesPtr)
417 : m_indices(indicesPtr)
420 inline Map(
const StorageIndex* indicesPtr,
Index size)
421 : m_indices(indicesPtr,size)
425 template<
typename Other>
426 Map& operator=(
const PermutationBase<Other>& other)
427 {
return Base::operator=(other.derived()); }
430 template<
typename Other>
431 Map& operator=(
const TranspositionsBase<Other>& tr)
432 {
return Base::operator=(tr.derived()); }
434 #ifndef EIGEN_PARSED_BY_DOXYGEN
438 Map& operator=(
const Map& other)
440 m_indices = other.m_indices;
446 const IndicesType& indices()
const {
return m_indices; }
448 IndicesType& indices() {
return m_indices; }
452 IndicesType m_indices;
455template<
typename _IndicesType>
class TranspositionsWrapper;
457template<
typename _IndicesType>
458struct traits<PermutationWrapper<_IndicesType> >
460 typedef PermutationStorage StorageKind;
462 typedef typename _IndicesType::Scalar StorageIndex;
463 typedef _IndicesType IndicesType;
465 RowsAtCompileTime = _IndicesType::SizeAtCompileTime,
466 ColsAtCompileTime = _IndicesType::SizeAtCompileTime,
467 MaxRowsAtCompileTime = IndicesType::MaxSizeAtCompileTime,
468 MaxColsAtCompileTime = IndicesType::MaxSizeAtCompileTime,
485template<
typename _IndicesType>
489 typedef internal::traits<PermutationWrapper> Traits;
492 #ifndef EIGEN_PARSED_BY_DOXYGEN
493 typedef typename Traits::IndicesType IndicesType;
501 const typename internal::remove_all<typename IndicesType::Nested>::type&
506 typename IndicesType::Nested m_indices;
512template<
typename MatrixDerived,
typename PermutationDerived>
514const Product<MatrixDerived, PermutationDerived, AliasFreeProduct>
524template<
typename PermutationDerived,
typename MatrixDerived>
526const Product<PermutationDerived, MatrixDerived, AliasFreeProduct>
535template<
typename PermutationType>
536class InverseImpl<PermutationType, PermutationStorage>
537 :
public EigenBase<Inverse<PermutationType> >
539 typedef typename PermutationType::PlainPermutationType PlainPermutationType;
540 typedef internal::traits<PermutationType> PermTraits;
544 typedef Inverse<PermutationType> InverseType;
545 using EigenBase<Inverse<PermutationType> >::derived;
547 #ifndef EIGEN_PARSED_BY_DOXYGEN
548 typedef typename PermutationType::DenseMatrixType DenseMatrixType;
550 RowsAtCompileTime = PermTraits::RowsAtCompileTime,
551 ColsAtCompileTime = PermTraits::ColsAtCompileTime,
552 MaxRowsAtCompileTime = PermTraits::MaxRowsAtCompileTime,
553 MaxColsAtCompileTime = PermTraits::MaxColsAtCompileTime
557 #ifndef EIGEN_PARSED_BY_DOXYGEN
558 template<
typename DenseDerived>
559 void evalTo(MatrixBase<DenseDerived>& other)
const
562 for (
Index i=0; i<derived().rows();++i)
563 other.coeffRef(i, derived().nestedExpression().indices().coeff(i)) =
typename DenseDerived::Scalar(1);
568 PlainPermutationType eval()
const {
return derived(); }
570 DenseMatrixType toDenseMatrix()
const {
return derived(); }
574 template<
typename OtherDerived>
friend
575 const Product<OtherDerived, InverseType, AliasFreeProduct>
576 operator*(
const MatrixBase<OtherDerived>& matrix,
const InverseType& trPerm)
578 return Product<OtherDerived, InverseType, AliasFreeProduct>(matrix.derived(), trPerm.derived());
583 template<
typename OtherDerived>
584 const Product<InverseType, OtherDerived, AliasFreeProduct>
585 operator*(
const MatrixBase<OtherDerived>& matrix)
const
587 return Product<InverseType, OtherDerived, AliasFreeProduct>(derived(), matrix.derived());
591template<
typename Derived>
592const PermutationWrapper<const Derived> MatrixBase<Derived>::asPermutation()
const
599template<>
struct AssignmentKind<DenseShape,PermutationShape> {
typedef EigenBase2EigenBase Kind; };
Derived & setZero()
Definition: CwiseNullaryOp.h:546
Derived & derived()
Definition: EigenBase.h:46
Scalar & coeffRef(Index row, Index col)
Definition: DenseCoeffsBase.h:342
Expression of the inverse of another expression.
Definition: Inverse.h:44
Map(PointerArgType dataPtr, const StrideType &stride=StrideType())
Definition: Map.h:129
Base class for all dense matrices, vectors, and expressions.
Definition: MatrixBase.h:50
The matrix class, also used for vectors and row-vectors.
Definition: Matrix.h:180
Scalar & coeffRef(Index rowId, Index colId)
Definition: PlainObjectBase.h:175
Base class for permutations.
Definition: PermutationMatrix.h:47
InverseReturnType transpose() const
Definition: PermutationMatrix.h:191
Derived & applyTranspositionOnTheLeft(Index i, Index j)
Definition: PermutationMatrix.h:155
void resize(Index newSize)
Definition: PermutationMatrix.h:125
Index determinant() const
Definition: PermutationMatrix.h:242
Index size() const
Definition: PermutationMatrix.h:97
Index cols() const
Definition: PermutationMatrix.h:94
Derived & applyTranspositionOnTheRight(Index i, Index j)
Definition: PermutationMatrix.h:174
friend PlainPermutationType operator*(const InverseImpl< Other, PermutationStorage > &other, const PermutationBase &perm)
Definition: PermutationMatrix.h:235
void setIdentity()
Definition: PermutationMatrix.h:131
Derived & operator=(const PermutationBase< OtherDerived > &other)
Definition: PermutationMatrix.h:74
IndicesType & indices()
Definition: PermutationMatrix.h:121
void setIdentity(Index newSize)
Definition: PermutationMatrix.h:140
PlainPermutationType operator*(const InverseImpl< Other, PermutationStorage > &other) const
Definition: PermutationMatrix.h:227
const IndicesType & indices() const
Definition: PermutationMatrix.h:119
Index rows() const
Definition: PermutationMatrix.h:91
InverseReturnType inverse() const
Definition: PermutationMatrix.h:185
DenseMatrixType toDenseMatrix() const
Definition: PermutationMatrix.h:113
Derived & operator=(const TranspositionsBase< OtherDerived > &tr)
Definition: PermutationMatrix.h:82
PlainPermutationType operator*(const PermutationBase< Other > &other) const
Definition: PermutationMatrix.h:219
Permutation matrix.
Definition: PermutationMatrix.h:298
PermutationMatrix(const TranspositionsBase< Other > &tr)
Definition: PermutationMatrix.h:338
PermutationMatrix(const MatrixBase< Other > &indices)
Definition: PermutationMatrix.h:333
PermutationMatrix(const PermutationBase< OtherDerived > &other)
Definition: PermutationMatrix.h:322
PermutationMatrix & operator=(const PermutationBase< Other > &other)
Definition: PermutationMatrix.h:346
const IndicesType & indices() const
Definition: PermutationMatrix.h:360
IndicesType & indices()
Definition: PermutationMatrix.h:362
PermutationMatrix & operator=(const TranspositionsBase< Other > &tr)
Definition: PermutationMatrix.h:354
PermutationMatrix(Index size)
Definition: PermutationMatrix.h:315
Class to view a vector of integers as a permutation matrix.
Definition: PermutationMatrix.h:487
const internal::remove_all< typenameIndicesType::Nested >::type & indices() const
Definition: PermutationMatrix.h:502
Expression of the product of two arbitrary matrices or vectors.
Definition: Product.h:75
Namespace containing all symbols from the Eigen library.
Definition: Core:141
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
const Product< MatrixDerived, PermutationDerived, AliasFreeProduct > operator*(const MatrixBase< MatrixDerived > &matrix, const PermutationBase< PermutationDerived > &permutation)
Definition: PermutationMatrix.h:515
Definition: EigenBase.h:30
Eigen::Index Index
The interface type of indices.
Definition: EigenBase.h:39
Derived & derived()
Definition: EigenBase.h:46
Holds information about the various numeric (i.e. scalar) types allowed by Eigen.
Definition: NumTraits.h:233