Skip to content

Commit

Permalink
Add tpie::priority_queue(mm_avail) to documentation (closes #244)
Browse files Browse the repository at this point in the history
  • Loading branch information
SSoelvsten committed May 24, 2022
1 parent 776217b commit 0f8eb6d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions tpie/priority_queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,20 @@ class priority_queue {
static constexpr float default_blocksize = 0.0625;

///////////////////////////////////////////////////////////////////////////
/// \brief Constructor.
/// \brief Constructor with fractional amount of internal memory to use.
///
/// \param f Factor of memory that the priority queue is allowed to use.
/// \param b Block factor
///////////////////////////////////////////////////////////////////////////
priority_queue(double f=1.0, float b=default_blocksize, stream_size_type n = std::numeric_limits<stream_size_type>::max());

#ifndef DOXYGEN
// \param mmavail Number of bytes the priority queue is allowed to use.
// \param b Block factor
///////////////////////////////////////////////////////////////////////////
/// \brief Constructor with absolute amount of internal memory to use.
///
/// \param mmavail Number of bytes the priority queue is allowed to use.
/// \param b Block factor
///////////////////////////////////////////////////////////////////////////
priority_queue(memory_size_type mm_avail, float b=default_blocksize, stream_size_type n = std::numeric_limits<stream_size_type>::max());
#endif

/////////////////////////////////////////////////////////
///
Expand Down

0 comments on commit 0f8eb6d

Please sign in to comment.