linbox
Public Member Functions
Permutation< _Field, _Storage > Class Template Reference

size is n. More...

#include <permutation.h>

Inherits BlackboxInterface.

Public Member Functions

 Permutation (Storage &indices, const Field &F=Field())
 Constructor from a vector of indices. More...
 
 Permutation (int n, const Field &F=Field())
 Constructor from a dimension. More...
 
template<class OutVector , class InVector >
OutVector & apply (OutVector &y, const InVector &x) const
 Application of BlackBox permutation matrix. More...
 
template<class OutVector , class InVector >
OutVector & applyTranspose (OutVector &y, const InVector &x) const
 Application of BlackBox permutation matrix transpose. More...
 
size_t rowdim (void) const
 rowdim
 
size_t coldim (void) const
 coldim
 
void permute (size_t row1, size_t row2)
 Add a transposition to the matrix.
 

Detailed Description

template<class _Field, class _Storage = std::vector< long >>
class LinBox::Permutation< _Field, _Storage >

size is n.

Parameters
StorageLinBox dense or sparse vector of field elements

Constructor & Destructor Documentation

Permutation ( Storage &  indices,
const Field &  F = Field() 
)
inline

Constructor from a vector of indices.

This constructor creates a permutation matrix based on a vector of indices

Parameters
F
indicesVector of indices representing the permutation
Permutation ( int  n,
const Field &  F = Field() 
)
inline

Constructor from a dimension.

This constructor creates an n x n permutation matrix, initialized to be the identity

Parameters
nThe dimension of hte matrix to create
F

Member Function Documentation

OutVector& apply ( OutVector &  y,
const InVector &  x 
) const
inline

Application of BlackBox permutation matrix.

$y \leftarrow Px$. Requires one vector conforming to the LinBox vector archetype. Required by abstract base class.

Returns
reference to vector y containing output.
Parameters
xconstant reference to vector to contain input
y
OutVector& applyTranspose ( OutVector &  y,
const InVector &  x 
) const
inline

Application of BlackBox permutation matrix transpose.

y= transpose(P)*x, equivalently y= P^-1*x Requires one vector conforming to the LinBox vector archetype. Required by abstract base class.

Returns
reference to vector y containing output.
Parameters
xconstant reference to vector to contain input
y$y^T \leftarrow x^T P$.

The documentation for this class was generated from the following file: