tpie::ami::stack< T > Class Template Reference

An implementation of an external-memory stack compatible with the old AMI interface. More...

#include <tpie/stack.h>

Public Member Functions
	stack ()
	Initializes the stack. More...
	stack (const std::string &path, stream_type type=READ_WRITE_STREAM)
	Initializes the stack by (re-)opening the file given. More...
err	push (const T &t)
	Pushes one item onto the stack. More...
err	pop (const T **t)
	Pops one item from the stack. More...
err	peek (const T **t)
	Peeks at the topmost item on the stack. More...
TPIE_OS_OFFSET	size () const
	Returns the number of items currently on the stack. More...
bool	is_empty () const
	Returns whether the stack is empty or not. More...
void	persist (persistence p)
	Set the persistence status of the (stream underlying the) stack. More...
persistence	persist () const
	Returns the persistence status of the (stream underlying the) stack. More...
err	trim ()
	Truncates the underlying stream to the exact size (rounded up to the next block) of items. More...
err	main_memory_usage (TPIE_OS_SIZE_T *usage, stream_usage usage_type) const
	Compute the memory used by the stack and the aggregated stream. More...
TPIE_OS_OFFSET	stream_len () const
tpie::stack< T > &	underlying_stack ()

Detailed Description

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

An implementation of an external-memory stack compatible with the old AMI interface.

Definition at line 180 of file stack.h.

Constructor & Destructor Documentation

stack() [1/2]

template<class T >

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

inline

Initializes the stack.

Definition at line 186 of file stack.h.

            :
        m_ulate(m_tempFile) {
        // Empty ctor.
    }

stack() [2/2]

template<class T >

tpie::ami::stack< T >::stack ( const std::string &  path, stream_type  type = READ_WRITE_STREAM  )

inline

Initializes the stack by (re-)opening the file given.

Parameters

path	The path to a file used for storing the items.
type	An stream_type that indicates the read/write mode of the file.

Definition at line 198 of file stack.h.

        : m_tempFile(path, true)
        , m_ulate(m_tempFile)
    {
        unused(type);
    }

Member Function Documentation

is_empty()

template<class T >

bool tpie::ami::stack< T >::is_empty ( ) const

inline

Returns whether the stack is empty or not.

Definition at line 244 of file stack.h.

                          {
        return m_ulate.empty();
    }

main_memory_usage()

template<class T >

err tpie::ami::stack< T >::main_memory_usage	(	TPIE_OS_SIZE_T *	usage,
		stream_usage	usage_type
	)		const

Compute the memory used by the stack and the aggregated stream.

Parameters

usage	Where the usage will be stored.
usage_type	The type of usage_type inquired from the stream.

Definition at line 373 of file stack.h.

                                                               {
    
    switch (usage_type) {
 
        //  All these types are o.k.
    case STREAM_USAGE_OVERHEAD:
    case STREAM_USAGE_CURRENT:
    case STREAM_USAGE_MAXIMUM:
    case STREAM_USAGE_SUBSTREAM:
    case STREAM_USAGE_BUFFER:
        *usage = tpie::stack<T>::memory_usage();
        *usage += sizeof(*this);
        break;
 
    default:
        tp_assert(0, "Unknown mem::stream_usage type added.");  
    }
    
    return NO_ERROR;
}

peek()

template<class T >

err tpie::ami::stack< T >::peek

(

const T **

t

)

Peeks at the topmost item on the stack.

Returns ERROR_* as given by the underlying stream or END_OF_STREAM if the stack is empty.

Parameters

t	A pointer to a pointer that will point to the topmost item.

Definition at line 349 of file stack.h.

                              {
    if(m_ulate.empty())
        return END_OF_STREAM;
 
    err retval = NO_ERROR;
    
    try {
 
        const T & res = m_ulate.top();
        *t = &res;
 
    } catch (end_of_stream_exception &) {
        retval = END_OF_STREAM;
    } catch (stream_exception &) {
        retval = IO_ERROR;
    }
 
    return retval;
 
}

persist() [1/2]

template<class T >

persistence tpie::ami::stack< T >::persist ( ) const

inline

Returns the persistence status of the (stream underlying the) stack.

Definition at line 261 of file stack.h.

                                { 
        return m_tempFile.is_persistent() ? PERSIST_PERSISTENT : PERSIST_DELETE;
    }

persist() [2/2]

template<class T >

void tpie::ami::stack< T >::persist ( persistence  p )

inline

Set the persistence status of the (stream underlying the) stack.

Parameters

p	A persistence status.

Definition at line 253 of file stack.h.

                                {
        m_tempFile.set_persistent(p == PERSIST_PERSISTENT);
    }

pop()

template<class T >

err tpie::ami::stack< T >::pop

(

const T **

t

)

Pops one item from the stack.

Returns ERROR_* as given by the underlying stream or END_OF_STREAM if the stack is empty.

Parameters

t	A pointer to a pointer that will point to the topmost item.

Definition at line 325 of file stack.h.

                             {
    if(m_ulate.empty())
        return END_OF_STREAM;
 
    err retval = NO_ERROR;
 
    try {
 
        const T & res = m_ulate.pop();
        *t = &res;
 
    } catch (end_of_stream_exception &) {
        retval = END_OF_STREAM;
    } catch (stream_exception &) {
        retval = IO_ERROR;
    }
 
    return retval;
 
}

push()

template<class T >

err tpie::ami::stack< T >::push

(

const T &

t

)

Pushes one item onto the stack.

Returns ERROR_* as given by the underlying stream.

Parameters

t	The item to be pushed onto the stack.

Definition at line 306 of file stack.h.

                             {
 
    err retval = NO_ERROR;
 
    try {
        m_ulate.push(t);
    } catch (end_of_stream_exception &) {
        retval = END_OF_STREAM;
    } catch (stream_exception &) {
        retval = IO_ERROR;
    }
 
    return retval;
 
}

size()

template<class T >

TPIE_OS_OFFSET tpie::ami::stack< T >::size ( ) const

inline

Returns the number of items currently on the stack.

Definition at line 237 of file stack.h.

                                {
        return m_ulate.size();
    }

stream_len()

template<class T >

TPIE_OS_OFFSET tpie::ami::stack< T >::stream_len ( ) const

inline

Definition at line 287 of file stack.h.

                                      {
        TP_LOG_WARNING_ID("Using AMI_stack<T>::stream_len() is deprecated.");
        return size();
    }

trim()

template<class T >

err tpie::ami::stack< T >::trim ( )

inline

Truncates the underlying stream to the exact size (rounded up to the next block) of items.

In the current implementation, this does nothing.

Definition at line 270 of file stack.h.

               {
        return NO_ERROR;
    }

---

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

• stack.h