stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ > Class Template Reference [Stream package]

Produces sorted stream from input stream. More...

#include <sort_stream.h>

Inherits noncopyable.

Collaboration diagram for stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >:

List of all members.

Public Types
typedef Input_::value_type	value_type
	Standard stream typedef.
Public Member Functions
	sort (Input_ &in, Cmp_ c, unsigned_type memory_to_use)
	Creates the object.
	sort (Input_ &in, Cmp_ c, unsigned_type memory_to_use_rc, unsigned_type memory_to_use_m)
	Creates the object.
const value_type &	operator* () const
	Standard stream method.
sort &	operator++ ()
	Standard stream method.
bool	empty () const
	Standard stream method.

---

Detailed Description

template<class Input_, class Cmp_, unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>
class stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >

Produces sorted stream from input stream.

Template parameters:

• Input_ type of the input stream
• Cmp_ type of comparison object used for sorting the runs
• BlockSize_ size of blocks used to store the runs
• AllocStr_ functor that defines allocation strategy for the runs

  Remarks:

  Implemented as the composition of runs_creator and runs_merger .

---

Member Typedef Documentation

template<class Input_ , class Cmp_ , unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>

typedef Input_::value_type stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >::value_type

Standard stream typedef.

---

Constructor & Destructor Documentation

template<class Input_ , class Cmp_ , unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>

stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >::sort	(	Input_ &	in,
		Cmp_	c,
		unsigned_type	memory_to_use
	)			[inline]

Creates the object.

Parameters:

	in	input stream
	c	comparator object
	memory_to_use	memory amount that is allowed to used by the sorter in bytes

template<class Input_ , class Cmp_ , unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>

stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >::sort	(	Input_ &	in,
		Cmp_	c,
		unsigned_type	memory_to_use_rc,
		unsigned_type	memory_to_use_m
	)			[inline]

Creates the object.

Parameters:

	in	input stream
	c	comparator object
	memory_to_use_rc	memory amount that is allowed to used by the runs creator in bytes
	memory_to_use_m	memory amount that is allowed to used by the merger in bytes

---

Member Function Documentation

template<class Input_ , class Cmp_ , unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>

bool stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >::empty

(

)

const [inline]

Standard stream method.

template<class Input_ , class Cmp_ , unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>

const value_type& stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >::operator*

(

)

const [inline]

Standard stream method.

template<class Input_ , class Cmp_ , unsigned BlockSize_ = STXXL_DEFAULT_BLOCK_SIZE(typename Input_::value_type), class AllocStr_ = STXXL_DEFAULT_ALLOC_STRATEGY>

sort& stream::sort< Input_, Cmp_, BlockSize_, AllocStr_ >::operator++

(

)

[inline]

Standard stream method.

---

The documentation for this class was generated from the following file:

• sort_stream.h