First commit
[anna.git] / include / anna / core / util / ExclusiveHash.hpp
1 // ANNA - Anna is Not 'N' Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // https://bitbucket.org/testillano/anna
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 #ifndef anna_core_util_ExclusiveHash_hpp
38 #define anna_core_util_ExclusiveHash_hpp
39
40 #include <map>
41
42 namespace anna {
43
44 /**
45    Template para calcular de forma univoca valores numericos del tipo de dato T.
46    Un valor T puede tener valores distintos para instancias distintas de ExclusiveHash.
47    La instancia T debe ser capaz de actuar como idice de una map<T,X>.
48
49    \param T Tipo de dato que queremos codificar numericamente.
50 */
51 template < class T, class _K = unsigned long > class ExclusiveHash {
52   typedef std::map <T, _K> container;
53   typedef typename container::value_type value_type;
54
55 public:
56   /**
57      Constructor.
58   */
59   ExclusiveHash() : a_value(0) {;}
60
61   /**
62      Calcula la funcion hash exclusiva para la instancia recibida como parametro.
63      \param t Instancia a la que vamos a calcular un valor numerico.
64   */
65   _K calcule(const T& t)
66   throw() {
67     typename container::iterator ii;
68     _K result = 0;
69
70     if((ii = a_container.find(t)) == a_container.end()) {
71       result = a_value ++;
72       a_container.insert(value_type(t, result));
73     } else
74       result = ii->second;
75
76     return result;
77   }
78
79 private:
80   container a_container;
81   _K a_value;
82 };
83
84 }
85
86 #endif