FeatureSet.hpp

Go to the documentation of this file.

/* 
 * FeatureSet.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_PHARM_FEATURESET_HPP
#define CDPL_PHARM_FEATURESET_HPP
 
#include <vector>
#include <unordered_map>
#include <memory>
 
#include <boost/iterator/indirect_iterator.hpp>
 
#include "CDPL/Pharm/APIPrefix.hpp"
#include "CDPL/Pharm/FeatureContainer.hpp"
 
 
namespace CDPL
{
 
    namespace Pharm
    {
 
        class CDPL_PHARM_API FeatureSet : public FeatureContainer
        {
 
            typedef std::vector<Feature*> FeatureList;
 
          public:
            typedef std::shared_ptr<FeatureSet> SharedPointer;
 
            typedef boost::indirect_iterator<FeatureList::const_iterator, const Feature> ConstFeatureIterator;
 
            typedef boost::indirect_iterator<FeatureList::iterator, Feature> FeatureIterator;
 
            FeatureSet();
 
            FeatureSet(const FeatureSet& ftr_set);
 
            explicit FeatureSet(const FeatureContainer& cntnr);
 
            ~FeatureSet();
 
            std::size_t getNumFeatures() const;
 
            bool containsFeature(const Feature& feature) const;
 
            std::size_t getFeatureIndex(const Feature& feature) const;
 
            ConstFeatureIterator getFeaturesBegin() const;
 
            FeatureIterator getFeaturesBegin();
 
            ConstFeatureIterator getFeaturesEnd() const;
 
            FeatureIterator getFeaturesEnd();
 
            const Feature& getFeature(std::size_t idx) const;
 
            Feature& getFeature(std::size_t idx);
 
            bool addFeature(const Feature& feature);
 
            void removeFeature(std::size_t idx);
 
            FeatureIterator removeFeature(const FeatureIterator& it);
 
            bool removeFeature(const Feature& feature);
 
            void clear();
 
            void orderFeatures(const FeatureCompareFunction& func);
            
            FeatureSet& operator=(const FeatureSet& ftr_set);
 
            FeatureSet& operator=(const FeatureContainer& cntnr);
 
            FeatureSet& operator+=(const FeatureContainer& cntnr);
 
            FeatureSet& operator-=(const FeatureContainer& cntnr);
 
          private:
            typedef std::unordered_map<const Feature*, std::size_t> FeatureIndexMap;
 
            FeatureList     features;
            FeatureIndexMap featureIndices;
        };
    } // namespace Pharm
} // namespace CDPL
 
#endif // CDPL_PHARM_FEATURESET_HPP