Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tpie::priority_queue(mm_avail) to documentation #252

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add tpie::priority_queue(mm_avail) to documentation #252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions tpie/priority_queue.h
View file
Open in desktop
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