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 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
|
/************************************************************************
*
* Copyright (C) 2022-2024 IRCAD France
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <algorithm>
#include <cmath>
#include <limits>
#include <memory>
#include <type_traits>
namespace sight::core
{
/**
* @brief This header defines "is_equal" comparison helper functions, especially usefull for floating point comparison
*
* It also defines some template helpers to allow identify a type as a container, as a shared pointer, ...
*
* @section Template Template helpers
*
* @subsection is_container is_container
*
* Allows to identify a type as a container that can be iterated.
*
* @code{.cpp}
template<typename T, typename std::enable_if_t<is_container<T>::value>* = nullptr>
bool is_equal(const T& a, const T& b) {...}
* @endcode
*
* @subsection is_map is_map, is_multimap, is_unordered_map, is_unordered_multimap
*
* Allows to identify a type as a map that can be iterated and value accessed using a key.
*
* @code{.cpp}
template<typename T, typename std::enable_if_t<is_map<T>::value>* = nullptr>
bool is_equal(const T& a, const T& b) {...}
* @endcode
*
* @subsection is_shared_ptr is_shared_ptr, is_unique_ptr, is_weak_ptr
*
* Allows to identify a type as a pointer (std::shared_ptr, std::unique_ptr, std::weak_ptr) that can be dereferenced
* using '*' operator.
*
* @code{.cpp}
template<typename T, typename std::enable_if_t<is_shared_ptr<T>::value>* = nullptr>
bool is_equal(const T& a, const T& b) {...}
* @endcode
*
* @section is_equal is_equal
*
* @subsection is_equal_real is_equal(real, real)
*
* Compares two real values using a scaled epsilon which is similar as ULP method.
* Near zero, NaN and inf cases are also specifically managed.
* @code{.cpp}
double a = 1.0;
double b = 1.0;
if(is_equal(a, b)) {...}
* @endcode
*
* @subsection is_equal_pointer is_equal(pointer, pointer)
*
* Compares two pointed values by dereferencing pointers. It first checks if the two pointers are the same, then
* dereferences them and call is_equal() again. Weak_ptr are first converted to shared_ptr before comparison.
*
* @code{.cpp}
auto a = std::make_unique<double>(1.0);
auto b = std::make_shared<double>(1.0);
if(is_equal(a, b)) {...}
* @endcode
*
* @subsection is_equal_container is_equal(container, container)
*
* Compares contained values by iterating over elements. If the container have the same size, it calls is_equal() on
* each elements.
*
* @code{.cpp}
std::vector<double> a = {1.0, 2.0, 3.0};
std::vector<double> b = {1.0, 2.0, 3.0};
if(is_equal(a, b)) {...}
* @endcode
*/
// cspell:ignore crbegin crend
/// Template matching utilities
template<typename ... ts>
struct is_helper {};
/// Allows to check if a type is a container.
/// @see https://en.cppreference.com/w/cpp/container
template<typename T, typename = void>
struct is_container : std::false_type {};
template<typename T>
struct is_container<
T,
std::conditional_t<
false,
is_helper<
typename T::value_type,
typename T::reference,
typename T::const_reference,
typename T::iterator,
typename T::const_iterator,
typename T::size_type,
typename T::difference_type,
decltype(std::declval<T>().begin()),
decltype(std::declval<T>().end()),
decltype(std::declval<T>().cbegin()),
decltype(std::declval<T>().cend()),
decltype(std::declval<T>().size()),
decltype(std::declval<T>().max_size()),
decltype(std::declval<T>().empty()),
// Also found in most containers
typename T::pointer,
typename T::const_pointer
>,
void
>
>: std::true_type {};
/// Allows to check if a type is an ordered container.
template<typename T, typename = void, typename = void>
struct is_container_ordered : std::false_type {};
template<typename T>
struct is_container_ordered<
T,
std::enable_if_t<is_container<T>::value>,
std::conditional_t<
false,
is_helper<
typename T::reverse_iterator,
typename T::const_reverse_iterator,
decltype(std::declval<T>().rbegin()),
decltype(std::declval<T>().rend()),
decltype(std::declval<T>().crbegin()),
decltype(std::declval<T>().crend())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a dynamic container (ie not an array).
template<typename T, typename = void, typename = void>
struct is_container_dynamic : std::false_type {};
template<typename T>
struct is_container_dynamic<
T,
std::enable_if_t<is_container<T>::value>,
std::conditional_t<
false,
is_helper<
typename T::allocator_type,
decltype(std::declval<T>().get_allocator()),
decltype(std::declval<T>().clear())
>,
void
>
>: std::true_type {};
template<typename T, typename = void, typename = void>
struct is_container_sequenced : std::false_type {};
template<typename T>
struct is_container_sequenced<
T,
std::enable_if_t<is_container_ordered<T>::value>,
std::conditional_t<
false,
is_helper<
decltype(std::declval<T>().front()),
decltype(std::declval<T>().back())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::array
template<typename T, typename = void, typename = void>
struct is_array : std::false_type {};
template<typename T>
struct is_array<
T,
std::enable_if_t<
is_container_sequenced<T>::value
&& !is_container_dynamic<T>::value
>,
std::conditional_t<
false,
is_helper<
decltype(std::declval<T>().data())
>,
void
>
>: std::true_type {};
/// Allows to check if a type have push_back() method.
template<typename T, typename = void, typename = void>
struct is_container_back_inserter : std::false_type {};
template<typename T>
struct is_container_back_inserter<
T,
std::enable_if_t<
is_container_sequenced<T>::value
&& is_container_dynamic<T>::value
>,
std::conditional_t<
false,
is_helper<
decltype(std::declval<T>().pop_back())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of boost::multi_index
template<typename T, typename = void, typename = void>
struct is_sequenced_set : std::false_type {};
template<typename T>
struct is_sequenced_set<
T,
std::enable_if_t<is_container_back_inserter<T>::value>,
std::conditional_t<
false,
is_helper<
typename T::ctor_args,
typename T::tag_list,
typename T::node_type,
typename T::insert_return_type,
decltype(std::declval<T>().capacity()),
decltype(std::declval<T>().shrink_to_fit()),
decltype(std::declval<T>().pop_front()),
decltype(std::declval<T>().pop_back()),
decltype(std::declval<T>().unique()),
decltype(std::declval<T>().sort()),
decltype(std::declval<T>().reverse())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::vector
template<typename T, typename = void, typename = void>
struct is_vector : std::false_type {};
template<typename T>
struct is_vector<
T,
std::enable_if_t<
is_container_back_inserter<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
decltype(std::declval<T>().capacity()),
decltype(std::declval<T>().shrink_to_fit()),
decltype(std::declval<T>().data())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::deque
template<typename T, typename = void, typename = void>
struct is_deque : std::false_type {};
template<typename T>
struct is_deque<
T,
std::enable_if_t<
is_container_back_inserter<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
decltype(std::declval<T>().shrink_to_fit()),
decltype(std::declval<T>().pop_front())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::list
template<typename T, typename = void, typename = void>
struct is_list : std::false_type {};
template<typename T>
struct is_list<
T,
std::enable_if_t<
is_container_back_inserter<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
decltype(std::declval<T>().pop_front()),
decltype(std::declval<T>().unique()),
decltype(std::declval<T>().sort()),
decltype(std::declval<T>().reverse())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of ordered associative container
template<typename T, typename = void, typename = void>
struct is_container_ordered_associative : std::false_type {};
template<typename T>
struct is_container_ordered_associative<
T,
std::enable_if_t<
is_container_ordered<T>::value
&& is_container_dynamic<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::key_type,
typename T::key_compare,
typename T::node_type,
decltype(std::declval<T>().key_comp()),
decltype(std::declval<T>().value_comp())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::map
template<typename T, typename = void, typename = void>
struct is_map : std::false_type {};
template<typename T>
struct is_map<
T,
std::enable_if_t<
is_container_ordered_associative<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::insert_return_type,
typename T::mapped_type
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::multimap
template<typename T, typename = void, typename = void>
struct is_multimap : std::false_type {};
template<typename T>
struct is_multimap<
T,
std::enable_if_t<
is_container_ordered_associative<T>::value
&& !is_map<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::mapped_type
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::set
template<typename T, typename = void, typename = void>
struct is_set : std::false_type {};
template<typename T>
struct is_set<
T,
std::enable_if_t<
is_container_ordered_associative<T>::value
&& !is_map<T>::value
&& !is_multimap<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::insert_return_type
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::multiset
template<typename T>
struct is_multiset : std::conditional_t<
is_container_ordered_associative<T>::value
&& !is_set<T>::value
&& !is_map<T>::value
&& !is_multimap<T>::value
&& !is_sequenced_set<T>::value,
std::true_type,
std::false_type
> {};
/// Allows to check if a type is a kind of unordered associative container
template<typename T, typename = void, typename = void>
struct is_container_unordered_associative : std::false_type {};
template<typename T>
struct is_container_unordered_associative<
T,
std::enable_if_t<
is_container<T>::value
&& is_container_dynamic<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::key_type,
typename T::hasher,
typename T::key_equal,
typename T::local_iterator,
typename T::const_local_iterator,
typename T::node_type,
decltype(std::declval<T>().hash_function()),
decltype(std::declval<T>().key_eq()),
decltype(std::declval<T>().bucket_count()),
decltype(std::declval<T>().max_bucket_count()),
decltype(std::declval<T>().load_factor()),
decltype(std::declval<T>().max_load_factor())
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind od std::unordered_map
template<typename T, typename = void, typename = void>
struct is_unordered_map : std::false_type {};
template<typename T>
struct is_unordered_map<
T,
std::enable_if_t<
is_container_unordered_associative<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::mapped_type,
typename T::insert_return_type
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind od std::unordered_multimap
template<typename T, typename = void, typename = void>
struct is_unordered_multimap : std::false_type {};
template<typename T>
struct is_unordered_multimap<
T,
std::enable_if_t<
is_container_unordered_associative<T>::value
&& !is_unordered_map<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::mapped_type
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind od std::unordered_set
template<typename T, typename = void, typename = void>
struct is_unordered_set : std::false_type {};
template<typename T>
struct is_unordered_set<
T,
std::enable_if_t<
is_container_unordered_associative<T>::value
&& !is_unordered_map<T>::value
&& !is_unordered_multimap<T>::value
&& !is_sequenced_set<T>::value
>,
std::conditional_t<
false,
is_helper<
typename T::insert_return_type
>,
void
>
>: std::true_type {};
/// Allows to check if a type is a kind of std::unordered_multiset
template<typename T>
struct is_unordered_multiset : std::conditional_t<
is_container_unordered_associative<T>::value
&& !is_unordered_set<T>::value
&& !is_unordered_map<T>::value
&& !is_unordered_multimap<T>::value
&& !is_sequenced_set<T>::value,
std::true_type,
std::false_type
> {};
/// Helpers to know if a type is a kind of map (value_type is a pair)
template<typename T>
struct is_map_like : std::conditional_t<
(
is_map<T>::value
|| is_multimap<T>::value
|| is_unordered_map<T>::value
|| is_unordered_multimap<T>::value
)
&& !is_sequenced_set<T>::value,
std::true_type,
std::false_type
> {};
/// Helpers to know if a type is a kind of set (value_type is a pair)
template<typename T>
struct is_set_like : std::conditional_t<
(
is_set<T>::value
|| is_multiset<T>::value
|| is_unordered_set<T>::value
|| is_unordered_multiset<T>::value
)
&& !is_sequenced_set<T>::value,
std::true_type,
std::false_type
> {};
/// Helpers to know if a type is a kind of associative container
template<typename T>
struct is_container_associative : std::conditional_t<
(
is_container_ordered_associative<T>::value
|| is_container_unordered_associative<T>::value
)
&& !is_sequenced_set<T>::value,
std::true_type,
std::false_type
> {};
/// Allows to check if a type is a shared_ptr
template<class T>
struct is_shared_ptr : std::false_type {};
template<class T>
struct is_shared_ptr<std::shared_ptr<T> >: std::true_type {};
/// Allows to check if a type is a unique_ptr
template<class T>
struct is_unique_ptr : std::false_type {};
template<class T>
struct is_unique_ptr<std::unique_ptr<T> >: std::true_type {};
/// Allows to check if a type is a weak_ptr
template<class T>
struct is_weak_ptr : std::false_type {};
template<class T>
struct is_weak_ptr<std::weak_ptr<T> >: std::true_type {};
/// Allows to check if a type can be dereferenced.
template<typename T, typename = void>
struct is_dereferenceable : std::false_type {};
template<typename T>
struct is_dereferenceable<
T,
std::conditional_t<
false,
is_helper<
decltype(*(std::declval<T&>()))
>,
void
>
>: std::true_type
{
// Deduce the value type such that const is propagated
using value_type = std::remove_reference_t<decltype(*std::declval<T&>())>;
};
/// Allows to check if a type is a pair
template<class T, typename = void>
struct is_pair : std::false_type {};
template<class T>
struct is_pair<
T,
std::conditional_t<
false,
is_helper<
typename T::first_type,
typename T::second_type,
decltype(std::declval<T>().first),
decltype(std::declval<T>().second)
>,
void
>
>: std::true_type {};
/// This is a floating point comparison helper. It mainly use a scaled epsilon with some fallback.
/// @param _a left floating point number to compare
/// @param _b right floating point number to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<std::is_floating_point<T1>::value && std::is_floating_point<T2>::value>* = nullptr
>
constexpr static bool is_equal(T1 _a, T2 _b, T1 e = std::numeric_limits<T1>::epsilon())
{
if constexpr(std::is_same_v<T1, T2>)
{
// Special corner cases: NaN, Inf, ...
if(_a == _b)
{
// If direct compare is true, then it is certainly equal. Should also take care of Inf, ...
return true;
}
if(std::isinf(_a) || std::isinf(_b))
{
// If one of them is infinite, then they are certainly not equal.
return false;
}
if(const bool a_nan = std::isnan(_a), b_nan = std::isnan(_b); a_nan || b_nan)
{
// Normally, NaN == NaN returns false. We want the opposite
return a_nan && b_nan;
}
const T1 abs_diff = std::abs(_a - _b);
if(abs_diff <= e)
{
// This manage the case where we are near zero
return true;
}
// Otherwise, use a scaled epsilon
return abs_diff <= e* std::max(std::abs(_a), std::abs(_b));
}
else if constexpr(std::is_same_v<T1, float>|| std::is_same_v<T2, float>)
{
// In case one is float and the other is double or long double
return is_equal(
static_cast<float>(_a),
static_cast<float>(_b),
std::max(
static_cast<float>(e),
std::numeric_limits<float>::epsilon()
)
);
}
else if constexpr(std::is_same_v<T1, double>|| std::is_same_v<T2, double>)
{
// In case one is double and the other is long double
is_equal(
static_cast<double>(_a),
static_cast<double>(_b),
std::max(
static_cast<double>(e),
std::numeric_limits<double>::epsilon()
)
);
}
}
/// This is a mixed comparison helper. It cast the integral type to floating point or use == operator as needed
/// @param _a left number to compare
/// @param _b right number to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<
!is_pair<T1>::value
&& !is_pair<T2>::value
&& !is_container<T1>::value
&& !is_container<T2>::value
&& !is_dereferenceable<T1>::value
&& !is_weak_ptr<T1>::value
&& !std::is_pointer_v<T2>
&& !is_weak_ptr<T2>::value
&& (!std::is_floating_point_v<T1>|| !std::is_floating_point_v<T2>)
>* = nullptr
>
constexpr static bool is_equal(const T1& _a, const T2& _b)
{
if constexpr(std::is_integral_v<T1>&& std::is_floating_point_v<T2>)
{
return is_equal(static_cast<T2>(_a), _b);
}
else if constexpr(std::is_floating_point_v<T1>&& std::is_integral_v<T2>)
{
return is_equal(_a, static_cast<T1>(_b));
}
else
{
return _a == _b;
}
}
/// This is a pair comparison helper.
/// @param _a left pair to compare
/// @param _b right pair to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<is_pair<T1>::value && is_pair<T2>::value>* = nullptr
>
constexpr static bool is_equal(T1 _a, T2 _b)
{
return is_equal(_a.first, _b.first) && is_equal(_a.second, _b.second);
}
/// This is a weak pointer comparison helper. It automatically dereferences the pointer and compare the values
/// @param _a left weak pointer to compare
/// @param _b right weak pointer to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<is_weak_ptr<T1>::value || is_weak_ptr<T2>::value>* = nullptr
>
constexpr static bool is_equal(T1 _a, T2 _b)
{
// Manage weak_ptr cases
if constexpr(is_weak_ptr<T1>::value)
{
return is_equal(_a.lock(), _b);
}
else if constexpr(is_weak_ptr<T2>::value)
{
return is_equal(_a, _b.lock());
}
else
{
// Should not be reached
const auto a_ptr = _a.lock();
const auto b_ptr = _b.lock();
return _a == _b || is_equal(*a_ptr, *b_ptr);
}
}
/// This is a pointer comparison helper. It automatically dereferences the pointer and compare the values
/// @param _a left pointer to compare
/// @param _b right pointer to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<is_dereferenceable<T1>::value && is_dereferenceable<T2>::value>* = nullptr
>
constexpr static bool is_equal(T1 _a, T2 _b)
{
// c++ forbids to compare pointers to different types
if constexpr(std::is_same_v<T1, T2>)
{
// Simple fast pointer comparison,
if(_a == _b)
{
return true;
}
}
else if(_a == nullptr && _b == nullptr)
{
return true;
}
if(_a == nullptr || _b == nullptr)
{
return false;
}
// Dereferenced comparison
return is_equal(*_a, *_b);
}
/// This is a comparison helper for container. It uses internally is_equal() for each element.
/// @param _a left container to compare
/// @param _b right container to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<is_container_ordered<T1>::value && is_container_ordered<T2>::value>* = nullptr
>
constexpr static bool is_equal(const T1& _a, const T2& _b)
{
if(_a.size() != _b.size())
{
return false;
}
auto a_it = _a.cbegin();
auto b_it = _b.cbegin();
const auto a_end = _a.cend();
while(a_it != a_end)
{
if constexpr(is_map_like<T1>::value && is_map_like<T2>::value)
{
if(!is_equal(a_it->first, b_it->first) || !is_equal(a_it->second, b_it->second))
{
return false;
}
}
else
{
if(!is_equal(*a_it, *b_it))
{
return false;
}
}
++a_it;
++b_it;
}
return true;
}
/// This is a comparison helper for unordered container. It may be a bit inefficient due to the unordered nature.
/// @param _a left map to compare
/// @param _b right map to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<
is_container_unordered_associative<T1>::value
&& is_container_unordered_associative<T2>::value
&& ((is_map_like<T1>::value && is_map_like<T2>::value)
|| (is_set_like<T1>::value && is_set_like<T2>::value))
>* = nullptr
>
constexpr static bool is_equal(const T1& _a, const T2& _b)
{
if(_a.size() != _b.size())
{
return false;
}
const auto b_end = _b.cend();
// Map case
if constexpr(is_map_like<T1>::value && is_map_like<T2>::value)
{
for(const auto& [a_key, a_value] : _a)
{
const auto& b_it = _b.find(a_key);
if(b_it == b_end)
{
return false;
}
if(!is_equal(a_value, b_it->second))
{
return false;
}
}
}
// Set case
else if constexpr(is_set_like<T1>::value && is_set_like<T2>::value)
{
for(const auto& a_value : _a)
{
const auto& b_it = _b.find(a_value);
if(b_it == b_end)
{
return false;
}
if(!is_equal(a_value, *b_it))
{
return false;
}
}
}
return true;
}
/// This is a floating point less than comparison helper. It mainly use a scaled epsilon with some fallback.
/// This is not perfect, as no perfect solution exists
/// @param _a left floating point number to compare
/// @param _b right floating point number to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<std::is_floating_point_v<T1>&& std::is_floating_point_v<T2> >* = nullptr
>
constexpr static bool is_less(T1 _a, T2 _b)
{
if constexpr(std::is_same_v<T1, T2>)
{
// Special corner cases: NaN, Inf, ...
if(std::isnan(_a) || std::isnan(_b))
{
// If one of them is NaN, assume the comparison is always false.
return false;
}
if(std::isinf(_a) || std::isinf(_b))
{
// We assume std::isless returns true for -Inf < Inf and false for -Inf < -Inf
return std::isless(_a, _b);
}
const T1 diff = _a - _b;
if(diff < std::numeric_limits<T1>::epsilon())
{
// This manage the case where we are near zero
return std::isless(_a, _b);
}
// Otherwise, use a scaled epsilon
return diff < std::numeric_limits<T1>::epsilon() * std::max(std::abs(_a), std::abs(_b));
}
else if constexpr(std::is_same_v<T1, float>|| std::is_same_v<T2, float>)
{
// In case one is float and the other is double or long double
return is_less(static_cast<float>(_a), static_cast<float>(_b));
}
else if constexpr(std::is_same_v<T1, double>|| std::is_same_v<T2, double>)
{
// In case one is double and the other is long double
return is_less(static_cast<double>(_a), static_cast<double>(_b));
}
}
/// This is a floating point greater than comparison helper. It mainly use a scaled epsilon with some fallback.
/// This is not perfetc, as no perfect solution exists
/// @param _a left floating point number to compare
/// @param _b right floating point number to compare
template<
typename T1,
typename T2,
typename std::enable_if_t<std::is_floating_point_v<T1>&& std::is_floating_point_v<T2> >* = nullptr
>
constexpr static bool is_greater(T1 _a, T2 _b)
{
if constexpr(std::is_same_v<T1, T2>)
{
// Special corner cases: NaN, Inf, ...
if(std::isnan(_a) || std::isnan(_b))
{
// If one of them is NaN, assume the comparison is always false.
return false;
}
if(std::isinf(_a) || std::isinf(_b))
{
// We assume std::isgreater returns true for Inf > -Inf and false for Inf > Inf
return std::isgreater(_a, _b);
}
const T1 diff = _a - _b;
if(diff > std::numeric_limits<T1>::epsilon())
{
// This manage the case where we are near zero
return std::isgreater(_a, _b);
}
// Otherwise, use a scaled epsilon
return diff > std::numeric_limits<T1>::epsilon() * std::max(std::abs(_a), std::abs(_b));
}
else if constexpr(std::is_same_v<T1, float>|| std::is_same_v<T2, float>)
{
// In case one is float and the other is double or long double
return is_greater(static_cast<float>(_a), static_cast<float>(_b));
}
else if constexpr(std::is_same_v<T1, double>|| std::is_same_v<T2, double>)
{
// In case one is double and the other is long double
return is_greater(static_cast<double>(_a), static_cast<double>(_b));
}
}
} // namespace sight::core
|