#    This file is part of DEAP.
#
#    DEAP 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 3 of
#    the License, or (at your option) any later version.
#
#    DEAP 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 DEAP. If not, see <http://www.gnu.org/licenses/>.

"""This example contains the evolving test from *Potter, M. and De Jong, K.,
2001, Cooperative Coevolution: An Architecture for Evolving Co-adapted
Subcomponents.* section 4.2.4. The number of species is evolved by adding and
removing species as stagnation occurs.
"""

import random
try:
    import pylab
except ImportError:
    pylab = False

from deap import algorithms
from deap import tools

import coev_coop_base

IND_SIZE = coev_coop_base.IND_SIZE
SPECIES_SIZE = coev_coop_base.SPECIES_SIZE
NUM_SPECIES = 1
TARGET_SIZE = 30
IMPROVMENT_TRESHOLD = 0.5
IMPROVMENT_LENGTH = 5
EXTINCTION_TRESHOLD = 5.0


noise =      "*##*###*###*****##*##****#*##*###*#****##******##*#**#*#**######"
schematas = ("1##1###1###11111##1##1111#1##1###1#1111##111111##1#11#1#11######",
             "1##1###1###11111##1##1000#0##0###0#0000##000000##0#00#0#00######",
             "0##0###0###00000##0##0000#0##0###0#0000##001111##1#11#1#11######")

toolbox = coev_coop_base.toolbox
toolbox.register("evaluateContribution", coev_coop_base.matchSetContribution)

def main(extended=True, verbose=True):
    target_set = []
    species = []
    
    stats = tools.Statistics(lambda ind: ind.fitness.values, n=NUM_SPECIES)
    stats.register("Avg", tools.mean)
    stats.register("Std", tools.std)
    stats.register("Min", min)
    stats.register("Max", max)
    
    if verbose:
        column_names = ["gen", "evals"] + stats.functions.keys()
        logger = tools.EvolutionLogger(column_names)
        logger.logHeader()
    
    ngen = 300
    g = 0
    
    for i in range(len(schematas)):
        size = int(TARGET_SIZE/len(schematas))
        target_set.extend(toolbox.target_set(schematas[i], size))
    
    species = [toolbox.species() for _ in range(NUM_SPECIES)]
    species_index = range(NUM_SPECIES)
    last_index_added = species_index[-1]
    
    # Init with random a representative for each species
    representatives = [random.choice(species[i]) for i in range(NUM_SPECIES)]
    best_fitness_history = [None] * IMPROVMENT_LENGTH
    
    if pylab and extended:
        contribs = [[]]
        stag_gen = []
        collab = []
    
    while g < ngen:
        # Initialize a container for the next generation representatives
        next_repr = [None] * len(species)
        for (i, s), j in zip(enumerate(species), species_index):
            # Variate the species individuals
            s = algorithms.varAnd(s, toolbox, 0.6, 1.0)
            
            # Get the representatives excluding the current species
            r = representatives[:i] + representatives[i+1:]
            for ind in s:
                # Evaluate and set the individual fitness
                ind.fitness.values = toolbox.evaluate([ind] + r, target_set)
            
            stats.update(s, index=j, add=True)
            
            if verbose: 
                logger.logGeneration(gen="%d.%d" % (g, j), evals=len(s), stats=stats, index=j)
            
            # Select the individuals
            species[i] = toolbox.select(s, len(s))  # Tournament selection
            next_repr[i] = toolbox.get_best(s)[0]   # Best selection
            
            if pylab and extended:
                # Book keeping of the collaborative fitness
                collab.append(next_repr[i].fitness.values[0])
            
            g += 1
        
        representatives = next_repr
        
        # Keep representatives fitness for stagnation detection
        best_fitness_history.pop(0)
        best_fitness_history.append(representatives[0].fitness.values[0])
        
        try:
            diff = best_fitness_history[-1] - best_fitness_history[0]
        except TypeError:
            diff = float("inf")
        
        if pylab and extended:
            for (i, rep), j in zip(enumerate(representatives), species_index):
                contribs[j].append((toolbox.evaluateContribution(representatives,
                    target_set, i)[0], g-1))
        
        if diff < IMPROVMENT_TRESHOLD:
            if len(species) > 1:
                contributions = []
                for i in range(len(species)):
                    contributions.append(toolbox.evaluateContribution(representatives, target_set, i)[0])
                
                for i in reversed(range(len(species))):
                    if contributions[i] < EXTINCTION_TRESHOLD:
                        species.pop(i)
                        species_index.pop(i)
                        representatives.pop(i)
            
            last_index_added += 1
            best_fitness_history = [None] * IMPROVMENT_LENGTH
            species.append(toolbox.species())
            species_index.append(last_index_added)
            representatives.append(random.choice(species[-1]))
            if extended and pylab:
                stag_gen.append(g-1)
                contribs.append([])

    if extended:
        for r in representatives:
            # print final representatives without noise
            print "".join(str(x) for x, y in zip(r, noise) if y == "*")
    
    if extended and pylab:      # Ploting of the evolution
        line1, = pylab.plot(collab, "--", color="k")
        
        for con in contribs:
            try:
                con, g = zip(*con)
                line2, = pylab.plot(g, con, "-", color="k")
            except ValueError:
                pass
        
        axis = pylab.axis("tight")
        
        for s in stag_gen:
            pylab.plot([s, s], [0, axis[-1]], "--", color="k")
        
        pylab.legend((line1, line2), ("Collaboration", "Contribution"), loc="center right")
        pylab.xlabel("Generations")
        pylab.ylabel("Fitness")
        pylab.show()
    
if __name__ == "__main__":
    main()