stack_array.h

Go to the documentation of this file.

/*
 * stack_array.h
 *
 * Copyright (C) 2006  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Array on the stack.
 */

#ifndef WAVEPACKET_UTIL_STACK_ARRAY_H__
#define WAVEPACKET_UTIL_STACK_ARRAY_H__

// includes --------------------------------------------------------------------
#include "common/common.h"


/// \ingroup util

////////////////////////////////////////////////////////////////////////////////
//
//      stack_array<T, N>
//
//      1D array held on the stack
//
////////////////////////////////////////////////////////////////////////////////
template <class T, class N>
class stack_array {
public:
        typedef stack_array<T,N> stack_t;

        stack_array(void) throw() { this->clear(); }

        const T& operator[](IN int i) const throw() {
                        ASSERT(i >= 0, "i = %d", i);
                        ASSERT(i < N::eMaxArraySize, "i = %d", i);
                        return m_array[i];
                }

        T& operator[](IN int i) throw() {
                        ASSERT(i >= 0, "i = %d", i);
                        ASSERT(i < N::eMaxArraySize, "i = %d", i);
                        return m_array[i];
                }

        int size(void) const throw() {
                        return m_size;
                }

        void clear(void) throw() {
                        m_size = 0;
                }

        const T * getDataPointer(void) const throw() {
                        return m_array;
                }

        T * getDataPointer(void) throw() {
                        return m_array;
                }

        void push_back(IN T t) throw() {
                        ASSERT(m_size < N::eMaxArraySize,
                            "Stack array has just blown out");
                        m_array[m_size] = t;
                        ++m_size;
                }

private:
        T               m_array[N::eMaxArraySize];
        int             m_size;
};



#endif  // WAVEPACKET_UTIL_STACK_ARRAY_H__