permlib  0.2.9
Library for permutation computations
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
permlib::OrbitSet< PERM, PDOMAIN > Class Template Reference

stores an orbit in a set for fast contains() operation More...

#include <orbit_set.h>

Inheritance diagram for permlib::OrbitSet< PERM, PDOMAIN >:
permlib::Orbit< PERM, PDOMAIN >

Public Types

typedef std::set< PDOMAIN >::const_iterator const_iterator
 
- Public Types inherited from permlib::Orbit< PERM, PDOMAIN >
typedef PERM PERMtype
 type of permutation used for this orbit
 

Public Member Functions

virtual bool contains (const PDOMAIN &val) const
 true iff there exists a transversal element mapping $\alpha$ to val
 
bool empty () const
 true iff orbit is empty (i.e. contains no element at all)
 
template<class Action >
void orbit (const PDOMAIN &beta, const std::list< typename PERM::ptr > &generators, Action a)
 computes orbit of beta under generators More...
 
size_t size () const
 number of orbit elements
 
virtual const PDOMAIN & element () const
 returns one element of the orbit
 
const_iterator begin () const
 begin-iterator to orbit elements
 
const_iterator end () const
 end-iterator to orbit elements
 

Protected Member Functions

virtual bool foundOrbitElement (const PDOMAIN &alpha, const PDOMAIN &alpha_p, const typename PERM::ptr &p)
 callback when the orbit algorithm constructs an element alpha_p from alpha and p More...
 
- Protected Member Functions inherited from permlib::Orbit< PERM, PDOMAIN >
template<class Action >
void orbit (const PDOMAIN &beta, const std::list< typename PERM::ptr > &generators, Action a, std::list< PDOMAIN > &orbitList)
 computes orbit of beta under generators More...
 
template<class Action >
void orbitUpdate (const PDOMAIN &beta, const std::list< typename PERM::ptr > &generators, const typename PERM::ptr &g, Action a, std::list< PDOMAIN > &orbitList)
 updates an existing orbit of beta after one element has been added More...
 

Protected Attributes

std::set< PDOMAIN > m_orbitSet
 orbit elements as set
 

Detailed Description

template<class PERM, class PDOMAIN>
class permlib::OrbitSet< PERM, PDOMAIN >

stores an orbit in a set for fast contains() operation

Member Function Documentation

◆ foundOrbitElement()

template<class PERM , class PDOMAIN >
bool permlib::OrbitSet< PERM, PDOMAIN >::foundOrbitElement ( const PDOMAIN &  alpha,
const PDOMAIN &  alpha_p,
const typename PERM::ptr &  p 
)
inlineprotectedvirtual

callback when the orbit algorithm constructs an element alpha_p from alpha and p

Returns
true iff alpha_p is a new element that has not been seen before

Implements permlib::Orbit< PERM, PDOMAIN >.

◆ orbit()

template<class PERM , class PDOMAIN >
template<class Action >
void permlib::OrbitSet< PERM, PDOMAIN >::orbit ( const PDOMAIN &  beta,
const std::list< typename PERM::ptr > &  generators,
Action  a 
)
inline

computes orbit of beta under generators

Parameters
beta
generators
a()-callable structure that defines how a PERM acts on a PDOMAIN-element
See also
Transversal::TrivialAction

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