File size: 22,293 Bytes
9375c9a |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 |
// Copyright (C) 2003 Davis E. King ([email protected])
// License: Boost Software License See LICENSE.txt for the full license.
#ifndef DLIB_HASH_TABLE_KERNEl_1_
#define DLIB_HASH_TABLE_KERNEl_1_
#include "hash_table_kernel_abstract.h"
#include "../general_hash/general_hash.h"
#include "../algs.h"
#include "../interfaces/map_pair.h"
#include "../interfaces/enumerable.h"
#include "../interfaces/remover.h"
#include "../assert.h"
#include "../serialize.h"
#include <functional>
namespace dlib
{
template <
typename domain,
typename range,
typename mem_manager = default_memory_manager,
typename compare = std::less<domain>
>
class hash_table_kernel_1 : public enumerable<map_pair<domain, range> >,
public pair_remover<domain,range>
{
/*!
INITIAL VALUE
hash_size == 0
table == pointer to an array of num_of_buckets node pointers
num_of_buckets == the number of buckets in the hash table
current_element == 0
at_start_ == true
mask == num_of_buckets-1
CONVENTION
current_element_valid() == (current_element != 0)
element() == current_element->d and current_element->r
at_start_ == at_start()
if (current_element != 0) then
table[current_bucket] == a pointer to the linked list that contains
the node pointed to by current_element
mask == num_of_buckets-1
hash_size = size() == the number of elements in the hash_table and
table == pointer to an array of num_of_buckets node pointers and
num_of_buckets == the number of buckets in the hash table and
for all i:
table[i] == pointer to the first node in a linked list or
table[i] == 0 if this bucket is currently not in use
for all nodes:
d == the domain element stored in this node
r == the range element stored in this node which is associated with
d.
next == pointer to the next node in the linked list or
next == 0 if this is the last node in the linked list
!*/
struct node
{
node* next;
domain d;
range r;
};
class mpair : public map_pair<domain,range>
{
public:
const domain* d;
range* r;
const domain& key(
) const { return *d; }
const range& value(
) const { return *r; }
range& value(
) { return *r; }
};
public:
typedef domain domain_type;
typedef range range_type;
typedef compare compare_type;
typedef mem_manager mem_manager_type;
explicit hash_table_kernel_1(
unsigned long expnum
);
virtual ~hash_table_kernel_1(
);
void clear(
);
unsigned long count (
const domain& item
) const;
void add (
domain& d,
range& r
);
void remove (
const domain& d,
domain& d_copy,
range& r
);
void destroy (
const domain& d
);
const range* operator[] (
const domain& d
) const;
range* operator[] (
const domain& d
);
void swap (
hash_table_kernel_1& item
);
// functions from the remover interface
void remove_any (
domain& d,
range& r
);
// functions from the enumerable interface
inline size_t size (
) const;
bool at_start (
) const;
inline void reset (
) const;
bool current_element_valid (
) const;
const map_pair<domain,range>& element (
) const;
map_pair<domain,range>& element (
);
bool move_next (
) const;
private:
// data members
typename mem_manager::template rebind<node>::other pool;
typename mem_manager::template rebind<node*>::other ppool;
unsigned long hash_size;
node** table;
general_hash<domain> hash;
unsigned long num_of_buckets;
unsigned long mask;
mutable mpair p;
mutable unsigned long current_bucket;
mutable node* current_element;
mutable bool at_start_;
compare comp;
// restricted functions
hash_table_kernel_1(hash_table_kernel_1&);
hash_table_kernel_1& operator=(hash_table_kernel_1&);
};
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
inline void swap (
hash_table_kernel_1<domain,range,mem_manager,compare>& a,
hash_table_kernel_1<domain,range,mem_manager,compare>& b
) { a.swap(b); }
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void deserialize (
hash_table_kernel_1<domain,range,mem_manager,compare>& item,
std::istream& in
)
{
try
{
item.clear();
unsigned long size;
deserialize(size,in);
domain d;
range r;
for (unsigned long i = 0; i < size; ++i)
{
deserialize(d,in);
deserialize(r,in);
item.add(d,r);
}
}
catch (serialization_error& e)
{
item.clear();
throw serialization_error(e.info + "\n while deserializing object of type hash_table_kernel_1");
}
}
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// member function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
hash_table_kernel_1<domain,range,mem_manager,compare>::
hash_table_kernel_1(
unsigned long expnum
) :
hash_size(0),
current_element(0),
at_start_(true)
{
num_of_buckets = 1;
while (expnum != 0)
{
--expnum;
num_of_buckets <<= 1;
}
mask = num_of_buckets-1;
table = ppool.allocate_array(num_of_buckets);
for (unsigned long i = 0; i < num_of_buckets; ++i)
{
table[i] = 0;
}
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
hash_table_kernel_1<domain,range,mem_manager,compare>::
~hash_table_kernel_1(
)
{
for (unsigned long i = 0; i < num_of_buckets; ++i)
{
// delete this linked list
node* temp = table[i];
while (temp)
{
node* t = temp;
temp = temp->next;
pool.deallocate(t);
}
table[i] = 0;
}
ppool.deallocate_array(table);
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
clear(
)
{
if (hash_size > 0)
{
for (unsigned long i = 0; i < num_of_buckets; ++i)
{
// delete this linked list
node* temp = table[i];
while (temp)
{
node* t = temp;
temp = temp->next;
pool.deallocate(t);
}
table[i] = 0;
}
hash_size = 0;
}
// reset the enumerator
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
size_t hash_table_kernel_1<domain,range,mem_manager,compare>::
size(
) const
{
return hash_size;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
unsigned long hash_table_kernel_1<domain,range,mem_manager,compare>::
count(
const domain& d
) const
{
unsigned long items_found = 0;
node* temp = table[hash(d)&mask];
while (temp != 0)
{
// look for an element equivalent to d
if ( !(comp(temp->d , d) || comp(d , temp->d)) )
{
++items_found;
}
temp = temp->next;
}
return items_found;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
add(
domain& d,
range& r
)
{
unsigned long hash_value = hash(d)&mask;
// make a new node for this item
node& temp = *(pool.allocate());
exchange(d,temp.d);
exchange(r,temp.r);
// add this new node to the head of the linked list in bucket number hash_value
temp.next = table[hash_value];
table[hash_value] = &temp;
++hash_size;
// reset the enumerator
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
destroy(
const domain& d
)
{
node* last;
const unsigned long hash_value = hash(d)&mask;
node* temp = table[hash_value];
// if there is more than one thing in this bucket
if (temp->next != 0)
{
// start looking with the second item in the list
last = temp;
temp = temp->next;
while (true)
{
// if we hit the end of the list without finding item then it must
// be the first element in the list so splice it out
if (temp == 0)
{
temp = table[hash_value];
table[hash_value] = temp->next;
break;
}
// look for an element equivalent to item
if ( !(comp(temp->d , d) || comp(d , temp->d)) )
{
// splice out the node we want to remove
last->next = temp->next;
break;
}
last = temp;
temp = temp->next;
}
}
// else there is only one node in this linked list
else
{
table[hash_value] = 0;
}
pool.deallocate(temp);
--hash_size;
// reset the enumerator
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
remove(
const domain& d,
domain& d_copy,
range& r
)
{
node* last;
const unsigned long hash_value = hash(d)&mask;
node* temp = table[hash_value];
// if there is more than one thing in this bucket
if (temp->next != 0)
{
// start looking with the second item in the list
last = temp;
temp = temp->next;
while (true)
{
// if we hit the end of the list without finding item then it must
// be the first element in the list so splice it out
if (temp == 0)
{
temp = table[hash_value];
table[hash_value] = temp->next;
break;
}
// look for an element equivalent to item
if ( !(comp(temp->d , d) || comp(d , temp->d)) )
{
// splice out the node we want to remove
last->next = temp->next;
break;
}
last = temp;
temp = temp->next;
}
}
// else there is only one node in this linked list
else
{
table[hash_value] = 0;
}
exchange(d_copy,temp->d);
exchange(r,temp->r);
pool.deallocate(temp);
--hash_size;
// reset the enumerator
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
remove_any(
domain& d,
range& r
)
{
unsigned long i = 0;
// while the ith bucket is empty keep looking
while (table[i] == 0)
{
++i;
}
// remove the first node in the linked list in the ith bucket
node& temp = *(table[i]);
exchange(temp.d,d);
exchange(temp.r,r);
table[i] = temp.next;
pool.deallocate(&temp);
--hash_size;
// reset the enumerator
reset();
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
const range* hash_table_kernel_1<domain,range,mem_manager,compare>::
operator[](
const domain& d
) const
{
node* temp = table[hash(d)&mask];
while (temp != 0)
{
// look for an element equivalent to item
if ( !(comp(temp->d , d) || comp(d , temp->d)) )
return &(temp->r);
temp = temp->next;
}
return 0;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
range* hash_table_kernel_1<domain,range,mem_manager,compare>::
operator[](
const domain& d
)
{
node* temp = table[hash(d)&mask];
while (temp != 0)
{
// look for an element equivalent to item
if ( !(comp(temp->d , d) || comp(d , temp->d)) )
return &(temp->r);
temp = temp->next;
}
return 0;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
swap(
hash_table_kernel_1<domain,range,mem_manager,compare>& item
)
{
exchange(mask,item.mask);
exchange(table,item.table);
exchange(hash_size,item.hash_size);
exchange(num_of_buckets,item.num_of_buckets);
exchange(current_bucket,item.current_bucket);
exchange(current_element,item.current_element);
exchange(at_start_,item.at_start_);
pool.swap(item.pool);
ppool.swap(item.ppool);
exchange(p,item.p);
exchange(comp,item.comp);
}
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// enumerable function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
bool hash_table_kernel_1<domain,range,mem_manager,compare>::
at_start (
) const
{
return at_start_;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
void hash_table_kernel_1<domain,range,mem_manager,compare>::
reset (
) const
{
at_start_ = true;
current_element = 0;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
bool hash_table_kernel_1<domain,range,mem_manager,compare>::
current_element_valid (
) const
{
return (current_element != 0);
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
const map_pair<domain,range>& hash_table_kernel_1<domain,range,mem_manager,compare>::
element (
) const
{
p.d = &(current_element->d);
p.r = &(current_element->r);
return p;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
map_pair<domain,range>& hash_table_kernel_1<domain,range,mem_manager,compare>::
element (
)
{
p.d = &(current_element->d);
p.r = &(current_element->r);
return p;
}
// ----------------------------------------------------------------------------------------
template <
typename domain,
typename range,
typename mem_manager,
typename compare
>
bool hash_table_kernel_1<domain,range,mem_manager,compare>::
move_next (
) const
{
if (at_start_)
{
at_start_ = false;
// if the queue is empty then there is nothing to do
if (hash_size == 0)
{
return false;
}
else
{
// find the first element in the hash table
for (current_bucket = 0; true ; ++current_bucket)
{
if (table[current_bucket] != 0)
{
current_element = table[current_bucket];
break;
}
}
return true;
}
}
else
{
// if we have already enumerated every element
if (current_element == 0)
{
return false;
}
else
{
// find the next element if it exists
if (current_element->next != 0)
{
current_element = current_element->next;
return true;
}
else
{
// find next bucket with something in it
for (current_bucket+=1; current_bucket<num_of_buckets; ++current_bucket)
{
if (table[current_bucket] != 0)
{
// we just found the next bucket
current_element = table[current_bucket];
break;
}
}
// make sure we actually found another nonempty bucket
if (current_bucket == num_of_buckets)
{
// we didn't find anything
current_element = 0;
return false;
}
else
{
// we found another bucket
return true;
}
}
}
}
}
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_HASH_TABLE_KERNEl_1_
|