View source for cpp/filesystem/path/operator cmp

You do not have permission to edit this page, for the following reason:

Due to recent vandalism, editing of this page is temporarily disabled for new users.If you want to suggest a change, please leave a message on the suggestions page for new users instead (don't be surprised if that page appears vandalized!).

You can view and copy the source of this page:

{{title|1=operator==,!=,<,<=,>,>=,<=>{{small|(std::filesystem::path)}}}}
{{cpp/filesystem/path/navbar}}
{{dcl begin}}
{{dcl | num=1 | since=c++17 | 1=
friend bool operator==( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl | num=2 | since=c++17 | until=c++20 | 1=
friend bool operator!=( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl | num=3 | since=c++17 | until=c++20 | 1=
friend bool operator<( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl | num=4 | since=c++17 | until=c++20 | 1=
friend bool operator<=( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl | num=5 | since=c++17 | until=c++20 | 1=
friend bool operator>( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl | num=6 | since=c++17 | until=c++20 | 1=
friend bool operator>=( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl | num=7 | since=c++20 | 1=
friend std::strong_ordering
    operator<=>( const path& lhs, const path& rhs ) noexcept;
}}
{{dcl end}}

Compares two paths lexicographically.

@1@ Checks whether {{tt|lhs}} and {{tt|rhs}} are equal. Equivalent to {{c|!(lhs < rhs) && !(rhs < lhs)}}.

@2@ Checks whether {{tt|lhs}} and {{tt|rhs}} are not equal. Equivalent to {{c|!(lhs {{==}} rhs)}}.

@3@ Checks whether {{tt|lhs}} is less than {{tt|rhs}}. Equivalent to {{c|lhs.compare(rhs) < 0}}.

@4@ Checks whether {{tt|lhs}} is less than or equal to {{tt|rhs}}. Equivalent to {{c|!(rhs < lhs)}}.

@5@ Checks whether {{tt|lhs}} is greater than {{tt|rhs}}. Equivalent to {{c|rhs < lhs}}.

@6@ Checks whether {{tt|lhs}} is greater than or equal to {{tt|rhs}}. Equivalent to {{c|!(lhs < rhs)}}.

@7@ Obtains the three-way comparison result of {{tt|lhs}} and {{tt|rhs}}. Equivalent to {{c|1=lhs.compare(rhs) <=> 0}}.

{{cpp/hidden friend|std::filesystem::path|plural=yes}} This prevents undesirable conversions in the presence of a {{c|using namespace std::filesystem;}} ''using-directive''.

===Parameters===
{{par begin}}
{{par | lhs, rhs | the paths to compare}}
{{par end}}

===Return value===
@1-6@ {{c|true}} if the corresponding comparison yields, {{c|false}} otherwise.
@7@ {{c|std::strong_ordering::less}} if {{tt|lhs}} is less than {{tt|rhs}}, otherwise {{c|std::strong_ordering::greater}} if {{tt|rhs}} is less than {{tt|lhs}}, otherwise {{c|std::strong_ordering::equal}}.

===Notes===
Path equality and equivalence have different semantics.

In the case of equality, as determined by {{tt|operator{{==}}}}, only lexical representations are compared. Therefore, {{c|1=path("a") == path("b")}} is never {{c|true}}.

In the case of equivalence, as determined by {{ltf|cpp/filesystem/equivalent}}, it is checked whether two paths ''resolve'' to the same file system object. Thus {{c|equivalent("a", "b")}} will return {{c|true}} if the paths resolve to the same file.

===Defect reports===
{{dr list begin}}
{{dr list item|dr=3065|wg=lwg|std=C++17|before=allowed comparison of everything convertible to {{tt|path}} in the presence of a ''using-directive''|after=made hidden friend}}
{{dr list end}}

===See also===
{{dsc begin}}
{{dsc inc | cpp/filesystem/path/dsc compare}}
{{dsc end}}

{{langlinks|ja|zh}}

Templates used on this page:

Template:! (view source) (protected)
Template:= (edit)
Template:== (edit)
Template:ambox (view source) (protected)
Template:ambox/category (edit)
Template:ambox/core (edit)
Template:c (view source) (protected)
Template:c/core (view source) (protected)
Template:cat handler (edit)
Template:cat handler/blacklist (edit)
Template:cat handler/numbered (edit)
Template:cpp/filesystem/dsc equivalent (edit)

cppreference.com

Namespaces

Variants

Views

Actions

View source for cpp/filesystem/path/operator cmp