Permutation Class Reference

#include <Permutation.h>

Public Member Functions
void	swap (int x1, int x2, int sgn=1)
void	set (const std::vector< int > &v, int sgn=1)
void	set (int a)
void	set (int a, int b)
void	set (int a, int b, int c)
void	set (int a, int b, int c, int d)
void	set (int a, int b, int c, int d, int e)
void	setSign (int s)
void	reset (int n)
void	makeUnity ()
bool	isUnity () const
Permutation	getInverse () const
unsigned int	size () const
	Permutation (int n=1)
	Permutation (const Permutation &other)
int	sign () const
int	operator[] (int i) const
int &	operator[] (int i)
std::vector< int > &	mapValues (const std::vector< int > &in, std::vector< int > &out) const
std::vector< int >	mapValues (const std::vector< int > &in) const
template<typename T >
std::vector< T > &	mapOrder (const std::vector< T > &in, std::vector< T > &out) const
template<typename T >
std::vector< T > &	mapOrder (const MINT::PolymorphVector< T > &pv, std::vector< T > &out) const
template<typename T >
MINT::PolymorphVector< T > &	mapOrder (const MINT::PolymorphVector< T > &pv, MINT::PolymorphVector< T > &out) const
template<typename T >
std::vector< T >	mapOrder (const std::vector< T > &in) const
template<typename T >
MINT::PolymorphVector< T >	mapOrder (const MINT::PolymorphVector< T > &in) const
int	nPermutations () const
void	print (std::ostream &os=std::cout) const
Permutation	operator * (const Permutation &rhs) const
Permutation	operator/ (const Permutation &rhs) const
bool	operator< (const Permutation &rhs) const
bool	operator== (const Permutation &rhs) const
bool	operator<= (const Permutation &rhs) const
bool	operator> (const Permutation &rhs) const
bool	operator>= (const Permutation &rhs) const

Static Public Member Functions
static const Permutation &	unity ()

Protected Member Functions
int &	y_of_x (int i)
const int &	y_of_x (int i) const

Protected Attributes
std::vector< int >	_v
int	_sign

Static Protected Attributes
static Permutation *	__unit
static int	dummy = -9999

Detailed Description

Definition at line 18 of file Permutation.h.

Constructor & Destructor Documentation

Permutation() [1/2]

Permutation::Permutation ( int  n = 1 )

inline

Definition at line 55 of file Permutation.h.

: _v(n), _sign(1){reset(n);};

Permutation() [2/2]

Permutation::Permutation ( const Permutation &  other )

inline

Definition at line 56 of file Permutation.h.

    : _v(other._v), _sign(other._sign)
    {}

Member Function Documentation

getInverse()

Permutation Permutation::getInverse

(

)

const

Definition at line 84 of file Permutation.cpp.

                                         {
  Permutation newP(*this);
  for(unsigned int i=0; i< this->size(); i++){
    int newIndex = (*this)[i];
    if(newIndex < 0 || newIndex >= (int) this->size()){
      cout << "ERROR in  Permutation::getInverse(): "
       << " found that I am an invalid permutation when trying to"
       << " invert myself. This is me:\n" << *this << endl;
      cout << "  Will carry on as best as I can..." <<endl;
      continue;
    }
    newP[newIndex] = i;
  }
  return newP;
}

isUnity()

bool Permutation::isUnity

(

)

const

Definition at line 47 of file Permutation.cpp.

                               {
  for(unsigned int i=0; i < size(); i++){
    if (_v[i] != (int) i) return false;
  }
  return true;
}

makeUnity()

void Permutation::makeUnity

(

)

Definition at line 42 of file Permutation.cpp.

                           {
  for(unsigned int i=0; i < size(); i++){
    _v[i] = i;
  }
}

mapOrder() [1/5]

template<typename T >

std::vector<T>& Permutation::mapOrder ( const std::vector< T > &  in, std::vector< T > &  out  ) const

inline

Definition at line 91 of file Permutation.h.

                                          {
    out.resize(in.size());
    unsigned int to = in.size();
    if(in.size() > this->size()){
      to = this->size();
      for(unsigned int i = this->size(); i < in.size(); i++) out[i] = in[i];
    }
    
    for(unsigned int i=0; i < to; i++){
      out[y_of_x(i)] = in[i];
    }
    return out;    
  }

mapOrder() [2/5]

template<typename T >

std::vector<T>& Permutation::mapOrder ( const MINT::PolymorphVector< T > &  pv, std::vector< T > &  out  ) const

inline

Definition at line 107 of file Permutation.h.

                                           {
    return mapOrder(pv.theVector(), out);
  }

mapOrder() [3/5]

template<typename T >

MINT::PolymorphVector<T>& Permutation::mapOrder ( const MINT::PolymorphVector< T > &  pv, MINT::PolymorphVector< T > &  out  ) const

inline

Definition at line 112 of file Permutation.h.

                                                     {
    mapOrder(pv.theVector(), out.theVector());
    return out;
  }

mapOrder() [4/5]

template<typename T >

std::vector<T> Permutation::mapOrder ( const std::vector< T > &  in ) const

inline

Definition at line 119 of file Permutation.h.

                                                       {
    std::vector<T> out(in.size());
    return mapOrder(in, out);
  }

mapOrder() [5/5]

template<typename T >

MINT::PolymorphVector<T> Permutation::mapOrder ( const MINT::PolymorphVector< T > &  in ) const

inline

Definition at line 124 of file Permutation.h.

                                                                           {
    MINT::PolymorphVector<T> out(in.size());
    return mapOrder(in, out);
  }

mapValues() [1/2]

std::vector<int>& Permutation::mapValues ( const std::vector< int > &  in, std::vector< int > &  out  ) const

inline

Definition at line 70 of file Permutation.h.

                                              {
    // same as mapValues below, except no new vector needs allocating
    // good when time is precious...
    if(this->isUnity()){
      out = in;
      return out;
    }

    out.resize(in.size());
    for(unsigned int i=0; i < in.size(); i++){
      out[i] = y_of_x(in[i]);
    }
    return out;
  }

mapValues() [2/2]

std::vector<int> Permutation::mapValues ( const std::vector< int > &  in ) const

inline

Definition at line 85 of file Permutation.h.

                                                          {
    std::vector<int> out(in.size());
    return mapValues(in, out);
  }

nPermutations()

int Permutation::nPermutations

(

)

const

Definition at line 100 of file Permutation.cpp.

                                    {
  int n=0;
  for(unsigned int i=0; i< size()-1; ++i){
    for(unsigned int j=i+1; j< size(); j++){
      if( y_of_x(i) > y_of_x(j) ) ++n;
    }
  }
  return n;
}

operator *()

Permutation Permutation::operator *

(

const Permutation &

rhs

)

const

Definition at line 122 of file Permutation.cpp.

                                                              {
  unsigned int newSize = this->size();
  if(rhs.size() > newSize) newSize = rhs.size();
  Permutation newP(newSize);

  for(unsigned int i=0; i < newSize; i++){
    int rhsMapping = -1;
    if(i >= rhs.size()){
      rhsMapping = i;
    }else{
      rhsMapping = rhs[i];
    }
    if(rhsMapping > (int) this->size() || rhsMapping < 0){
      newP[i] = rhsMapping;
    }else{
      newP[i] = (*this)[rhsMapping];
    }
  }
  return newP;
}

operator/()

Permutation Permutation::operator/

(

const Permutation &

rhs

)

const

Definition at line 143 of file Permutation.cpp.

                                                              {
  return (*this)* rhs.getInverse();
}

operator<()

bool Permutation::operator<

(

const Permutation &

rhs

)

const

Definition at line 147 of file Permutation.cpp.

                                                       {

  if(this->size() < rhs.size()) return true;
  if(this->size() > rhs.size()) return false;

  for(unsigned int i=0; i< this->size(); i++){
    if( (*this)[i] < rhs[i] ) return true;
    if( (*this)[i] > rhs[i] ) return false;
  }
  return false;
}

operator<=()

bool Permutation::operator<=

(

const Permutation &

rhs

)

const

Definition at line 168 of file Permutation.cpp.

                                                        {
  return ( (*this) < rhs || (*this) == rhs);
}

operator==()

bool Permutation::operator==

(

const Permutation &

rhs

)

const

Definition at line 159 of file Permutation.cpp.

                                                        {

  if(this->size() != rhs.size()) return false;

  for(unsigned int i=0; i< this->size(); i++){
    if( (*this)[i] != rhs[i] ) return false;
  }
  return true;
}

operator>()

bool Permutation::operator>

(

const Permutation &

rhs

)

const

Definition at line 171 of file Permutation.cpp.

                                                       {
  return ! ((*this) <= rhs);
}

operator>=()

bool Permutation::operator>=

(

const Permutation &

rhs

)

const

Definition at line 174 of file Permutation.cpp.

                                                        {
  return ! ((*this) < rhs);
}

operator[]() [1/2]

int Permutation::operator[] ( int  i ) const

inline

Definition at line 62 of file Permutation.h.

                              {
    return y_of_x(i);
  }

operator[]() [2/2]

int& Permutation::operator[] ( int  i )

inline

Definition at line 66 of file Permutation.h.

                         {
    return y_of_x(i);
  }

print()

void Permutation::print

(

std::ostream &

os = std::cout

)

const

Definition at line 110 of file Permutation.cpp.

                                           {

  for(unsigned int i=0; i < size(); i++){
    os << '\t' << i;
  }
  os << "\n ->";
  for(unsigned int i=0; i < size(); i++){
    os << '\t' << (*this)[i];
  }

}

reset()

void Permutation::reset

(

int

n

)

Definition at line 38 of file Permutation.cpp.

                            {
  _v.resize(n);
  makeUnity();
}

set() [1/6]

void Permutation::set	(	const std::vector< int > &	v,
		int	sgn = 1
	)

Definition at line 61 of file Permutation.cpp.

                                                     {
  _v=v;
  _sign =sgn;
}

set() [2/6]

void Permutation::set

(

int

a

)

Definition at line 66 of file Permutation.cpp.

                          {
  _v.resize(1); (*this)[0]=a;
}

set() [3/6]

void Permutation::set	(	int	a,
		int	b
	)

Definition at line 69 of file Permutation.cpp.

                                 {
  _v.resize(2); (*this)[0]=a; (*this)[1]=b;
}

set() [4/6]

void Permutation::set	(	int	a,
		int	b,
		int	c
	)

Definition at line 72 of file Permutation.cpp.

                                        {
  _v.resize(3); (*this)[0]=a; (*this)[1]=b; (*this)[2]=c;
}

set() [5/6]

void Permutation::set	(	int	a,
		int	b,
		int	c,
		int	d
	)

Definition at line 75 of file Permutation.cpp.

                                               {
  _v.resize(4); (*this)[0]=a; (*this)[1]=b; (*this)[2]=c; (*this)[3]=d;
}

set() [6/6]

void Permutation::set	(	int	a,
		int	b,
		int	c,
		int	d,
		int	e
	)

Definition at line 78 of file Permutation.cpp.

                                                      {
  _v.resize(4); (*this)[0]=a; (*this)[1]=b; (*this)[2]=c; (*this)[3]=d; (*this)[4]=e;
}

setSign()

void Permutation::setSign

(

int

s

)

Definition at line 81 of file Permutation.cpp.

                              {
  _sign = s;
}

sign()

int Permutation::sign ( ) const

inline

Definition at line 60 of file Permutation.h.

{return _sign;}

size()

unsigned int Permutation::size ( ) const

inline

Definition at line 53 of file Permutation.h.

{ return _v.size();}

swap()

void Permutation::swap	(	int	x1,
		int	x2,
		int	sgn = 1
	)

Definition at line 54 of file Permutation.cpp.

                                             {
  int tmp = y_of_x(x1);
  y_of_x(x1) = y_of_x(x2);
  y_of_x(x2) = tmp;
  _sign *= sgn;
}

unity()

const Permutation & Permutation::unity ( )

static

Definition at line 10 of file Permutation.cpp.

                                     {
  if(0 == __unit){
    __unit = new Permutation();
    __unit->makeUnity();
  }
  return *__unit;
}

y_of_x() [1/2]

int & Permutation::y_of_x ( int  i )

protected

Definition at line 19 of file Permutation.cpp.

                             {
  if(i >= (int) _v.size() || i < 0){
    cout << "Permutation::y_of_x for x = " << i
     << " out of range [0," << (_v.size()-1) << "]." 
     << endl;
    return dummy;
  }
  return _v[i];
}

y_of_x() [2/2]

const int & Permutation::y_of_x ( int  i ) const

protected

Definition at line 28 of file Permutation.cpp.

                                         {
  if(i >= (int) _v.size() || i < 0){
    cout << "Permutation::y_of_x for x = " << i
     << " out of range [0," << (_v.size()-1) << "]." 
     << endl;
    return dummy;
  }
  return _v[i];
}

Member Data Documentation

__unit

Permutation * Permutation::__unit

staticprotected

Definition at line 27 of file Permutation.h.

_sign

int Permutation::_sign

protected

Definition at line 23 of file Permutation.h.

_v

std::vector<int> Permutation::_v

protected

Definition at line 22 of file Permutation.h.

dummy

int Permutation::dummy = -9999

staticprotected

Definition at line 30 of file Permutation.h.

---

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

• Mint/Permutation.h
• src/Mojito/Symmetries/Permutation.cpp