tpie::stack< T > Class Template Reference

An implementation of an external-memory stack. More...

#include <tpie/stack.h>

Public Member Functions
	stack (double blockFactor=1.0)
	Initialize anonymous stack. More...
	stack (const std::string &path, double block_factor=1.0)
	Initialize named, nontemporary stack. More...
	stack (temp_file &tempFile, double block_factor=1.0)
	Initialize temporary stack. More...
	~stack ()
	Closes the underlying stream and truncates it to the logical end of the stack. More...
void	push (const T &t) throw (stream_exception)
	Pushes one item onto the stack. More...
const T &	pop () throw (stream_exception)
	Pops one item from the stack. More...
const T &	top () throw (stream_exception)
	Peeks at the topmost item on the stack. More...
stream_size_type	size () const
	Returns the number of items currently on the stack. More...
bool	empty () const
	Returns whether the stack is empty or not. More...

Static Public Member Functions
static memory_size_type	memory_usage (float blockFactor=1.0)
	Compute the memory used by a stack. More...

Protected Attributes
file_stream< T >	m_file_stream
	The file_stream used to store the items. More...

Detailed Description

template<typename T>
class tpie::stack< T >

An implementation of an external-memory stack.

Definition at line 39 of file stack.h.

Constructor & Destructor Documentation

template<typename T>

tpie::stack< T >::stack ( double  blockFactor = 1.0 )

inline

Initialize anonymous stack.

Definition at line 45 of file stack.h.

        : m_file_stream(blockFactor)
        , m_buffer(buffer_size(blockFactor))
        , m_bufferItems(0)
    {
        m_file_stream.open(static_cast<memory_size_type>(0), access_normal);
    }

template<typename T>

tpie::stack< T >::stack ( const std::string &  path, double  block_factor = 1.0  )

inline

Initialize named, nontemporary stack.

Parameters

path	The path to a file used for storing the items.
block_factor	The block factor to use

Definition at line 59 of file stack.h.

        : m_file_stream(block_factor)
        , m_buffer(buffer_size(block_factor))
        , m_bufferItems(0)
    {
        m_file_stream.open(path, access_read_write, static_cast<memory_size_type>(0), access_normal);
        
        m_file_stream.seek(0, file_stream_base::end);
    }

template<typename T>

tpie::stack< T >::stack ( temp_file &  tempFile, double  block_factor = 1.0  )

inline

Initialize temporary stack.

Parameters

tempFile	The temporary file containing the stack
block_factor	The block factor to use

Definition at line 75 of file stack.h.

        : m_file_stream(block_factor)
        , m_buffer(buffer_size(block_factor))
        , m_bufferItems(0)
    {
        m_file_stream.open(tempFile, access_read_write, 
                           static_cast<memory_size_type>(0), access_normal);
        
        m_file_stream.seek(0, file_stream_base::end);
    }

template<typename T>

tpie::stack< T >::~stack ( )

inline

Closes the underlying stream and truncates it to the logical end of the stack.

Definition at line 91 of file stack.h.

             {
        empty_buffer();
        m_file_stream.truncate(this->size());
    }

Member Function Documentation

template<typename T>

bool tpie::stack< T >::empty ( ) const

inline

Returns whether the stack is empty or not.

m_file_stream.can_read_back();

Definition at line 136 of file stack.h.

Referenced by tpie::pipelining::bits::reverser_output_t< dest_t >::go().

                              {
        return size()  == 0;
    }

template<typename T>

static memory_size_type tpie::stack< T >::memory_usage ( float  blockFactor = 1.0 )

inlinestatic

Compute the memory used by a stack.

Definition at line 143 of file stack.h.

Referenced by tpie::ami::stack< T >::main_memory_usage().

                                                                       {
        return sizeof(stack<T>)
            + file_stream<T>::memory_usage(blockFactor)
            + array<T>::memory_usage(buffer_size(blockFactor));
    }

template<typename T>

const T& tpie::stack< T >::pop ( ) throw ( stream_exception )

inline

Pops one item from the stack.

Definition at line 110 of file stack.h.

Referenced by tpie::pipelining::bits::reverser_output_t< dest_t >::go().

                                                   {
        if (m_bufferItems) return m_buffer[--m_bufferItems];
        const T & item = m_file_stream.read_back();
        return item;
    }

template<typename T>

void tpie::stack< T >::push ( const T &  t ) throw ( stream_exception )

inline

Pushes one item onto the stack.

Returns ERROR_* as given by the underlying stream.

Parameters

t	The item to push onto the stack.

Definition at line 102 of file stack.h.

                                                          {
        if (m_buffer.size() == m_bufferItems) empty_buffer();
        m_buffer[m_bufferItems++] = t;
    }

template<typename T>

stream_size_type tpie::stack< T >::size ( ) const

inline

Returns the number of items currently on the stack.

Definition at line 129 of file stack.h.

Referenced by tpie::stack< item_type >::empty(), tpie::pipelining::bits::reverser_output_t< dest_t >::propagate(), and tpie::stack< item_type >::~stack().

                                         {
        return m_file_stream.offset()+m_bufferItems;
    }

template<typename T>

const T& tpie::stack< T >::top ( ) throw ( stream_exception )

inline

Peeks at the topmost item on the stack.

Definition at line 119 of file stack.h.

                                                   {
        if (m_bufferItems) return m_buffer[m_bufferItems-1];
        m_buffer[0] = m_file_stream.read_back();
        m_file_stream.read();
        return m_buffer[0];
    }

Member Data Documentation

template<typename T>

file_stream<T> tpie::stack< T >::m_file_stream

protected

The file_stream used to store the items.

Definition at line 152 of file stack.h.

Referenced by tpie::stack< item_type >::pop(), tpie::stack< item_type >::size(), tpie::stack< item_type >::stack(), tpie::stack< item_type >::top(), and tpie::stack< item_type >::~stack().

---

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

• stack.h