abstract_permutation_group.h

// ---------------------------------------------------------------------------
//
//  This file is part of PermLib.
//
// Copyright (c) 2009-2012 Thomas Rehn <thomas@carmen76.de>
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
//    derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// ---------------------------------------------------------------------------
 
#include <vector>
#include <list>
#include <set>
 
#include <boost/cstdint.hpp>
#include <boost/foreach.hpp>
#include <boost/dynamic_bitset.hpp>
 
#include <permlib/common.h>
 
#ifndef ABSTRACT_PERMUTATION_GROUP_H_
#define ABSTRACT_PERMUTATION_GROUP_H_
 
namespace permlib {

enum AbstractGroupType {
        AGT_BSGS = 1,
        AGT_SymmetricProduct = 2
};

class AbstractPermutationGroup {
public:
        virtual ~AbstractPermutationGroup() {}
        
        template<typename Integer>
        Integer order() const;
        
        boost::uint64_t order() const;
        

        virtual AbstractPermutationGroup* setStabilizer(const std::vector<dom_int>& s) const = 0;
        
        typedef std::list<std::set<dom_int> > OrbitList;
        virtual OrbitList* orbits() const = 0;

        virtual OrbitList* orbits(const std::vector<dom_int>& s) const = 0;
        

        virtual bool isLexMinSet(const std::vector<dom_int>& setIndices, const std::vector<dom_int>& rankIndices) const = 0;

        virtual AbstractGroupType type() const = 0;
protected:
        virtual void transversalSizes(std::vector<unsigned long>& sizes) const = 0;
};
 
 
template <typename Integer>
Integer AbstractPermutationGroup::order() const {
        Integer orderValue(1);
        std::vector<unsigned long> sizes;
        transversalSizes(sizes);
        BOOST_FOREACH(const unsigned long &s, sizes) {
                orderValue *= s;
        }
        return orderValue;
}
 
inline boost::uint64_t AbstractPermutationGroup::order() const {
        return order<boost::uint64_t>();
}
 
} // end NS
 
#endif