Saf/Collection/HashMap.h

Go to the documentation of this file.

/*
    This file is part of Simple Application Framework (Saf) library.
    Copyright (C) 2010 - 2012 Ondrej Danek <ondrej.danek@gmail.com>

    This library 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.

    Saf 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 Simple Application Framework library. If not, 
    see <http://www.gnu.org/licenses/>.
*/

#ifndef SAF_COLLECTION_HASHMAP_H
#define SAF_COLLECTION_HASHMAP_H

#include "../Algo/Hash.h"
#include "../Algo/Struct/HashTable.h"
#include "../Algo/Struct/HashTablePolicy.h"
#include "../Algo/Predicate.h"
#include "../Algo/Selector.h"
#include "../IndexOutOfRangeException.h"
#include "Pair.h"

namespace Saf
{
    namespace Collection
    {
        template <class KeyType, class ValType, class HashFuncType = Algo::Hash<KeyType>, 
            class HashPolicyType = Algo::Struct::HashPolicy::PrimePolicy,
            class CompType = Algo::Predicate::Equal<KeyType> > 
        class HashMap
            : public Algo::Struct::HashTable<KeyType,Pair<const KeyType,ValType>,
                Algo::Selector::FirstMember<Pair<const KeyType,ValType> >,
                HashFuncType,HashPolicyType,CompType>
        {
        protected:
            typedef Pair<const KeyType,ValType> RecType;
            typedef Algo::Struct::HashTable<KeyType,RecType,Algo::Selector::FirstMember<RecType>,HashFuncType,HashPolicyType,CompType> BaseType;
            typedef HashMap<KeyType,ValType,HashFuncType,HashPolicyType,CompType> MyType;

        public:
            typedef typename BaseType::Iterator Iterator;
            typedef typename BaseType::ConstIterator ConstIterator;

        public:
            explicit HashMap(Size bucketHint = 0)
                : BaseType(bucketHint)
            {}

            HashMap(const MyType& d) 
                : BaseType(d)
            {}

            MyType& operator=(const MyType& d)
            {
                BaseType::operator=(d);
                return *this;
            }

            MyType& Swap(MyType& d)
            {
                BaseType::Swap(d);
                return *this;
            }

            ValType& operator[](const KeyType& key)
            {
                Iterator iter = Find(key);

                if (iter == this->End())
                {
                    return Insert(RecType(key, ValType())).m_first->m_second;
                }

                return iter->m_second;
            }

            Iterator Update(const KeyType& key, const ValType& val)
            {
                Pair<Iterator,bool> ins = Insert(RecType(key,val));

                if (!ins.m_second)
                {
                    ins.m_first->m_second = val.m_second;
                }

                return ins.m_first;
            }

            ValType& At(const KeyType& key)
            {
                Iterator iter = Find(key);

                if (iter == this->End())
                {
                    throw IndexOutOfRangeException(SAF_SOURCE_LOCATION, "Key does not exist in the dictionary.");
                }
                
                return iter->m_second;
            }

            const ValType& At(const KeyType& key) const
            {
                ConstIterator iter = Find(key);

                if (iter == this->End())
                {
                    throw IndexOutOfRangeException(SAF_SOURCE_LOCATION, "Key does not exist in the dictionary.");
                }
                
                return iter->m_second;
            }
        };
    }

    namespace Algo
    {
        // Swap specialization for dictionary container.
        template <class KeyType, class ValType, class HashFuncType, class HashPolicyType, class CompType>
        struct SwapFunc< Collection::HashMap<KeyType,ValType,HashFuncType,HashPolicyType,CompType> >
        {
            void operator()(Collection::HashMap<KeyType,ValType,HashFuncType,HashPolicyType,CompType>& x, 
                Collection::HashMap<KeyType,ValType,HashFuncType,HashPolicyType,CompType>& y)
            {
                x.Swap(y);
            }
        };
    }
}

#endif