| # <small>nlohmann::basic_json::</small>operator== | |
| ```cpp | |
| // until C++20 | |
| bool operator==(const_reference lhs, const_reference rhs) noexcept; // (1) | |
| template<typename ScalarType> | |
| bool operator==(const_reference lhs, const ScalarType rhs) noexcept(/* see below */); // (2) | |
| template<typename ScalarType> | |
| bool operator==(ScalarType lhs, const const_reference rhs) noexcept(/* see below */); // (2) | |
| // since C++20 | |
| bool operator==(const_reference rhs) const noexcept; // (1) | |
| template<typename ScalarType> | |
| bool operator==(ScalarType rhs) const noexcept(/* see below */); // (2) | |
| ``` | |
| 1. Compares two JSON values for equality according to the following rules: | |
| - Two JSON values are equal if (1) neither value is discarded, and (2) they are of the same type and their stored | |
| values are the same according to their respective `operator==`. | |
| - Integer and floating-point numbers are compared by their exact values, without converting the integer to | |
| floating-point. For instance, `9007199254740993` and `9007199254740992.0` are not equal. | |
| 2. Compares a JSON value and a scalar or a scalar and a JSON value for equality by converting the | |
| scalar to a JSON value and comparing both JSON values according to 1. | |
| ## Template parameters | |
| `ScalarType` | |
| : a scalar type according to `std::is_scalar<ScalarType>::value` | |
| ## Parameters | |
| `lhs` (in) | |
| : first value to consider | |
| `rhs` (in) | |
| : second value to consider | |
| ## Return value | |
| whether the values `lhs`/`*this` and `rhs` are equal | |
| ## Exception safety | |
| 1. No-throw guarantee: this function never throws exceptions. | |
| 2. No-throw guarantee if converting the scalar to a JSON value cannot throw, as for numbers, Booleans, and | |
| `#!cpp nullptr`; the function is `#!cpp noexcept` exactly in that case. Otherwise, it throws what the conversion | |
| throws, for example `std::bad_alloc` when converting a string, or | |
| [`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) for an enum value not mapped by | |
| [`NLOHMANN_JSON_SERIALIZE_ENUM_STRICT`](../macros/nlohmann_json_serialize_enum_strict.md). | |
| ## Complexity | |
| Linear. | |
| ## Notes | |
| !!! note "Comparing special values" | |
| - `NaN` values are unordered within the domain of numbers. | |
| The following comparisons all yield `#!cpp false`: | |
| 1. Comparing a `NaN` with itself. | |
| 2. Comparing a `NaN` with another `NaN`. | |
| 3. Comparing a `NaN` and any other number. | |
| - JSON `#!cpp null` values are all equal. | |
| - Discarded values never compare equal to themselves. | |
| !!! note "Comparing floating-point numbers" | |
| Floating-point numbers inside JSON values numbers are compared with `json::number_float_t::operator==` which is | |
| `double::operator==` by default. To compare floating-point while respecting an epsilon, an alternative | |
| [comparison function](https://github.com/mariokonrad/marnav/blob/master/include/marnav/math/floatingpoint.hpp#L34-#L39) | |
| could be used, for instance | |
| ```cpp | |
| template<typename T, typename = typename std::enable_if<std::is_floating_point<T>::value, T>::type> | |
| inline bool is_same(T a, T b, T epsilon = std::numeric_limits<T>::epsilon()) noexcept | |
| { | |
| return std::abs(a - b) <= epsilon; | |
| } | |
| ``` | |
| Or you can define your own equality function like this: | |
| ```cpp | |
| bool my_equal(const_reference lhs, const_reference rhs) | |
| { | |
| const auto lhs_type = lhs.type(); | |
| const auto rhs_type = rhs.type(); | |
| if (lhs_type == rhs_type) | |
| { | |
| switch(lhs_type) | |
| // self_defined case | |
| case value_t::number_float: | |
| return std::abs(lhs - rhs) <= std::numeric_limits<float>::epsilon(); | |
| // other cases remain the same with the original | |
| ... | |
| } | |
| ... | |
| } | |
| ``` | |
| !!! note "Comparing different `basic_json` specializations" | |
| Comparing different `basic_json` specializations can have surprising effects. For instance, the result of comparing | |
| the JSON objects | |
| ```json | |
| { | |
| "version": 1, | |
| "type": "integer" | |
| } | |
| ``` | |
| and | |
| ```json | |
| { | |
| "type": "integer", | |
| "version": 1 | |
| } | |
| ``` | |
| depends on whether [`nlohmann::json`](../json.md) or [`nlohmann::ordered_json`](../ordered_json.md) is used: | |
| ```cpp | |
| #include <iostream> | |
| #include <iomanip> | |
| #include <nlohmann/json.hpp> | |
| using json = nlohmann::json; | |
| int main() | |
| { | |
| nlohmann::json uj1 = {{"version", 1}, {"type", "integer"}}; | |
| nlohmann::json uj2 = {{"type", "integer"}, {"version", 1}}; | |
| nlohmann::ordered_json oj1 = {{"version", 1}, {"type", "integer"}}; | |
| nlohmann::ordered_json oj2 = {{"type", "integer"}, {"version", 1}}; | |
| std::cout << std::boolalpha << (uj1 == uj2) << '\n' << (oj1 == oj2) << std::endl; | |
| } | |
| ``` | |
| Output: | |
| ```json | |
| true | |
| false | |
| ``` | |
| ## Examples | |
| ??? example "Example: (1) compare JSON values" | |
| The example demonstrates comparing several JSON types. | |
| ```cpp | |
| #include <iostream> | |
| #include <nlohmann/json.hpp> | |
| using json = nlohmann::json; | |
| int main() | |
| { | |
| // create several JSON values | |
| json array_1 = {1, 2, 3}; | |
| json array_2 = {1, 2, 4}; | |
| json object_1 = {{"A", "a"}, {"B", "b"}}; | |
| json object_2 = {{"B", "b"}, {"A", "a"}}; | |
| json number_1 = 17; | |
| json number_2 = 17.000000000000001L; | |
| json string_1 = "foo"; | |
| json string_2 = "bar"; | |
| // output values and comparisons | |
| std::cout << std::boolalpha; | |
| std::cout << array_1 << " == " << array_2 << " " << (array_1 == array_2) << '\n'; | |
| std::cout << object_1 << " == " << object_2 << " " << (object_1 == object_2) << '\n'; | |
| std::cout << number_1 << " == " << number_2 << " " << (number_1 == number_2) << '\n'; | |
| std::cout << string_1 << " == " << string_2 << " " << (string_1 == string_2) << '\n'; | |
| } | |
| ``` | |
| Output: | |
| ```json | |
| [1,2,3] == [1,2,4] false | |
| {"A":"a","B":"b"} == {"A":"a","B":"b"} true | |
| 17 == 17.0 true | |
| "foo" == "bar" false | |
| ``` | |
| ??? example "Example: (2) compare JSON values with `#!cpp nullptr`" | |
| The example demonstrates comparing several JSON types against the null pointer (JSON `#!json null`). | |
| ```cpp | |
| #include <iostream> | |
| #include <nlohmann/json.hpp> | |
| using json = nlohmann::json; | |
| int main() | |
| { | |
| // create several JSON values | |
| json array = {1, 2, 3}; | |
| json object = {{"A", "a"}, {"B", "b"}}; | |
| json number = 17; | |
| json string = "foo"; | |
| json null; | |
| // output values and comparisons | |
| std::cout << std::boolalpha; | |
| std::cout << array << " == nullptr " << (array == nullptr) << '\n'; | |
| std::cout << object << " == nullptr " << (object == nullptr) << '\n'; | |
| std::cout << number << " == nullptr " << (number == nullptr) << '\n'; | |
| std::cout << string << " == nullptr " << (string == nullptr) << '\n'; | |
| std::cout << null << " == nullptr " << (null == nullptr) << '\n'; | |
| } | |
| ``` | |
| Output: | |
| ```json | |
| [1,2,3] == nullptr false | |
| {"A":"a","B":"b"} == nullptr false | |
| 17 == nullptr false | |
| "foo" == nullptr false | |
| null == nullptr true | |
| ``` | |
| ## See also | |
| - [operator!=](operator_ne.md) compare for inequality | |
| - [operator<=>](operator_spaceship.md) comparison: 3-way (C++20) | |
| - [basic_json_view::operator==](../basic_json_view/operator_eq.md) - the same comparison on a zero-copy view, without | |
| building a `basic_json` value for it | |
| ## Version history | |
| 1. Added in version 1.0.0. Added C++20 member functions in version 3.11.0. | |
| 2. Added in version 1.0.0. Added C++20 member functions in version 3.11.0. | |
| Made conditionally `#!cpp noexcept` in version 3.13.0; before, a throwing conversion called `std::terminate`. |