Population.hpp

/*
    Copyright 2009-2010 Stéphane De Mita, Mathieu Siol

    This file is part of the EggLib library.

    EggLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    EggLib 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with EggLib.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef EGGLIB_POPULATION_HPP
#define EGGLIB_POPULATION_HPP


#include "Edge.hpp"

namespace egglib {

    class Random;

    class Population {

        public:
    
            Population();
            
            Population(const Population& source);
            
            Population& operator=(const Population& source);
            
            ~Population();

            Population(unsigned int numberOfSegments,
                    unsigned int numberOfLineages, unsigned firstIndex);

            unsigned int numberOfLineages() const;
            
            unsigned int efficientNumberOfLineages() const;            
            
            void set(unsigned int index, Edge* edge);

            Edge* extractRandomly(Random* random);

            Edge* extractByIndex(unsigned int index);

            void push(Edge* edge);

            unsigned int coverage(unsigned int edgeIndex) const;


        private:

            void copy(const Population& source);
            void clear();
            Edge* pick(unsigned int index);
            void init();
            unsigned int _numberOfLineages;
            unsigned int _efficientNumberOfLineages;
            Edge** lineages;
    };

}

#endif