/*
<bimap.h>
Copyright (C) DOLPHIN Project-Team, INRIA Lille - Nord Europe, 2006-2012

Alexandre Quemy, Thibault Lasnier - INSA Rouen

This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software.  You can  ue,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and,  more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.

ParadisEO WebSite : http://paradiseo.gforge.inria.fr
Contact: paradiseo-help@lists.gforge.inria.fr
*/

#ifndef SMP_BIMAP_MODEL_H_
#define SMP_BIMAP_MODEL_H_

#include <map>

namespace paradiseo
{
namespace smp
{
/** Bimap

Bidirectional map in order to create a bijection between islands and vertices.
A and B objects are stocked in two std::map, then if you would like to avoid instances duplications,
template A and B with pointers.

**/

template<class A, class B>
class Bimap
{
public:
    /**
     * Add a relation 
     * @param A right key
     * @param B left key
     */
    void add(A& a, B& b);
    
    /**
     * Return a map which represents the right association.
     * @return rightAssociation
     */
    std::map<A,B> getRight() const;
    
     /**
     * Return a map which represents the left association.
     * @return leftAssociation
     */
    std::map<B,A> getLeft() const;
    
    /**
     * Remove an association from a right key.
     * @param Right key of the association to be removed.
     */
    void removeFromRight(const A& a);
    
    /**
     * Remove an association from a left key.
     * @param Left key of the association to be removed.
     */
    void removeFromLeft(const B& b);

    /**
     * Return the number of associations.
     * @return Size of bimap
     */
    unsigned size() const;
    
    /**
     * Check if the bimap is empty
     * @return true if the bimap is empty
     */
    bool empty() const;

protected:
    std::map<A,B> rightAssociation;
    std::map<B,A> leftAssociation;
};

#include <bimap.cpp>

}

}

#endif
