[#absl-c_is_heap-02]
= xref:absl.adoc[absl]::c_is_heap
:relfileprefix: ../
:mrdocs:

`c_is_heap` overloads

== Synopses

Declared in `<absl/algorithm/container.h>`

Container‐based version of the <algorithm> `std::is_heap()` function to check whether the given container is a heap.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename RandomAccessContainer>
constexpr
bool
xref:absl/c_is_heap-07.adoc[c_is_heap](RandomAccessContainer const& sequence);
----

[.small]#xref:absl/c_is_heap-07.adoc[_» more..._]#

Overload of `c_is_heap()` for performing heap comparisons using a `comp` other than `operator<`


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename RandomAccessContainer,
    typename LessThan>
constexpr
bool
xref:absl/c_is_heap-0c.adoc[c_is_heap](
    RandomAccessContainer const& sequence,
    LessThan&& comp);
----

[.small]#xref:absl/c_is_heap-0c.adoc[_» more..._]#

== Return Value

* `true` if `sequence` is a max heap, otherwise `false`.
* `true` if `sequence` is a heap under `comp`, otherwise `false`.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *sequence*
| The container to test.
| *comp*
| The comparison used to order the heap.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#