Skip to content

Commit 8ab834d

Browse files
committed
Add tpie::priority_queue(mm_avail) to documentation (closes #244)
1 parent 85c2792 commit 8ab834d

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

tpie/priority_queue.h

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,18 +82,20 @@ class priority_queue {
8282
static constexpr float default_blocksize = 0.0625;
8383

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

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

98100
/////////////////////////////////////////////////////////
99101
///

0 commit comments

Comments
 (0)