00001 // 00002 // Copyright (c) 2005-2008 Kenichi Watanabe. 00003 // Copyright (c) 2005-2008 Yasuhiro Watari. 00004 // Copyright (c) 2005-2008 Hironori Ichibayashi. 00005 // Copyright (c) 2008-2009 Kazuo Horio. 00006 // Copyright (c) 2009-2013 Naruki Kurata. 00007 // Copyright (c) 2005-2013 Ryota Shioya. 00008 // Copyright (c) 2005-2013 Masahiro Goshima. 00009 // 00010 // This software is provided 'as-is', without any express or implied 00011 // warranty. In no event will the authors be held liable for any damages 00012 // arising from the use of this software. 00013 // 00014 // Permission is granted to anyone to use this software for any purpose, 00015 // including commercial applications, and to alter it and redistribute it 00016 // freely, subject to the following restrictions: 00017 // 00018 // 1. The origin of this software must not be misrepresented; you must not 00019 // claim that you wrote the original software. If you use this software 00020 // in a product, an acknowledgment in the product documentation would be 00021 // appreciated but is not required. 00022 // 00023 // 2. Altered source versions must be plainly marked as such, and must not be 00024 // misrepresented as being the original software. 00025 // 00026 // 3. This notice may not be removed or altered from any source 00027 // distribution. 00028 // 00029 // 00030 00031 00032 #ifndef SHTTL_RPLCMNT_H 00033 #define SHTTL_RPLCMNT_H 00034 00035 #include "shttl_types.h" 00036 00037 namespace shttl 00038 { 00039 // 00040 // A base class of a replacer. 00041 // Each class that implements a replace algorithm inherits this class. 00042 // 00043 // 'key_type' is a type of a key passed by 'setassoc_table' and 00044 // is used for user implementation. 00045 // 00046 template < typename key_t > 00047 class replacer 00048 { 00049 public: 00050 typedef size_t size_type; 00051 typedef key_t key_type; 00052 static const size_type invalid_way = ~((size_type)0); 00053 00054 #ifdef SHTTL_DEBUG 00055 // These pure virtual functions are only for type checking. 00056 00057 virtual ~replacer() {} 00058 00059 // Constructs a replacer. 00060 virtual void construct( 00061 const size_type set_num, 00062 const size_type way_num 00063 ) = 0; 00064 00065 virtual void touch( 00066 const size_type index, 00067 const size_type way, 00068 const key_type key 00069 ) = 0; 00070 00071 virtual size_type target( 00072 const size_type index 00073 ) = 0; 00074 00075 #endif 00076 00077 }; 00078 00079 } // namespace shttl 00080 00081 #endif // SHTTL_RPLCMNT_H