permlib  0.2.6
Library for permutation computations
 All Classes Functions Variables Typedefs Enumerations Friends
include/permlib/transversal/orbit_list.h
00001 // ---------------------------------------------------------------------------
00002 //
00003 //  This file is part of PermLib.
00004 //
00005 // Copyright (c) 2009-2011 Thomas Rehn <thomas@carmen76.de>
00006 // All rights reserved.
00007 // 
00008 // Redistribution and use in source and binary forms, with or without
00009 // modification, are permitted provided that the following conditions
00010 // are met:
00011 // 1. Redistributions of source code must retain the above copyright
00012 //    notice, this list of conditions and the following disclaimer.
00013 // 2. Redistributions in binary form must reproduce the above copyright
00014 //    notice, this list of conditions and the following disclaimer in the
00015 //    documentation and/or other materials provided with the distribution.
00016 // 3. The name of the author may not be used to endorse or promote products
00017 //    derived from this software without specific prior written permission.
00018 // 
00019 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00020 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00021 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00022 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00023 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00024 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00025 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00026 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00028 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029 //
00030 // ---------------------------------------------------------------------------
00031 
00032 
00033 #ifndef ORBIT_LIST_H_
00034 #define ORBIT_LIST_H_
00035 
00036 #include <permlib/transversal/orbit.h>
00037 
00038 namespace permlib {
00039 
00041 template<class PERM,class PDOMAIN>
00042 class OrbitList : public Orbit<PERM,PDOMAIN> {
00043 public:
00044         virtual bool contains(const PDOMAIN& val) const;
00045 
00047         bool empty() const { return m_orbitList.empty(); }
00048 
00050 
00056         template<class Action>
00057         void orbit(const PDOMAIN& beta, const std::list<typename PERM::ptr> &generators, Action a);
00058 
00060         unsigned long size() const { return m_orbitList.size(); }
00061     
00062     virtual const PDOMAIN& element() const;
00063 protected:
00065         std::list<PDOMAIN> m_orbitList;
00066 
00067         virtual bool foundOrbitElement(const PDOMAIN& alpha, const PDOMAIN& alpha_p, const typename PERM::ptr& p);
00068 };
00069 
00070 template <class PERM,class PDOMAIN>
00071 inline bool OrbitList<PERM,PDOMAIN>::foundOrbitElement(const PDOMAIN& alpha, const PDOMAIN& alpha_p, const typename PERM::ptr& p) {
00072         typename std::list<PDOMAIN>::iterator it = std::lower_bound(m_orbitList.begin(), m_orbitList.end(), alpha_p);
00073         if (*it != alpha_p) {
00074                 m_orbitList.insert(it, alpha_p);
00075                 return true;
00076         }
00077         return false;
00078 }
00079 
00080 template <class PERM,class PDOMAIN>
00081 inline bool OrbitList<PERM,PDOMAIN>::contains(const PDOMAIN& val) const {
00082         return std::binary_search(m_orbitList.begin(), m_orbitList.end(), val);
00083 }
00084 
00085 template <class PERM,class PDOMAIN>
00086 template<class Action>
00087 inline void OrbitList<PERM,PDOMAIN>::orbit(const PDOMAIN& beta, const std::list<typename PERM::ptr> &generators, Action a) {
00088         // use separate list here because m_orbitList is sorted
00089         std::list<PDOMAIN> orbitList;
00090         Orbit<PERM,PDOMAIN>::orbit(beta, generators, a, orbitList);
00091 }
00092 
00093 template <class PERM,class PDOMAIN>
00094 inline const PDOMAIN& OrbitList<PERM,PDOMAIN>::element() const {
00095     return *(m_orbitList.begin());
00096 }
00097 
00098 }
00099 
00100 #endif // -- ORBIT_LIST_H_