LIFOStack.tpp

/*---------------------------------------------------------------------------*\
 *
 *  bitpit
 *
 *  Copyright (C) 2015-2021 OPTIMAD engineering Srl
 *
 *  -------------------------------------------------------------------------
 *  License
 *  This file is part of bitpit.
 *
 *  bitpit is free software: you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License v3 (LGPL)
 *  as published by the Free Software Foundation.
 *
 *  bitpit is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 *  License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with bitpit. If not, see <http://www.gnu.org/licenses/>.
 *
\*---------------------------------------------------------------------------*/
 
// ========================================================================== //
//                         - SORTING ALGORITHMS -                             //
//                                                                            //
// Functions for data sorting.                                                //
// ========================================================================== //
// INFO                                                                       //
// Author    : Alessandro Alaia                                               //
// Version   : v2.0                                                           //
//                                                                            //
// All rights reserved.                                                       //
// ========================================================================== //
 
namespace bitpit{
 
// ========================================================================== //
// TEMPLATE IMPLEMENTATIONS                                                   //
// ========================================================================== //
 
// Constructors ============================================================= //
 
// -------------------------------------------------------------------------- //
template <class T>
LIFOStack<T>::LIFOStack(
    void
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// CREATE LIFO STACK                                                          //
// ========================================================================== //
 
// Max stack dimensions
MAXSTK = 10;
 
// Initialize stack
increaseSTACK();
 
// Currenst stack size
TOPSTK = 0;
 
return; };
 
// -------------------------------------------------------------------------- //
template <class T>
LIFOStack<T>::LIFOStack(
    int         maxstack
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// CREATE LIFO STACK                                                          //
// ========================================================================== //
 
// Max stack dimensions
MAXSTK = maxstack;
 
// Initialize stack
increaseSTACK();
 
// Currenst stack size
TOPSTK = 0;
 
return; };
 
// -------------------------------------------------------------------------- //
template <class T>
LIFOStack<T>::LIFOStack(
    std::vector<T>  &items
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// CREATE LIFO STACK                                                          //
// ========================================================================== //
 
// Max stack dimensions
MAXSTK = items.size();
 
// Initialize stack
increaseSTACK();
 
// Currenst stack size
TOPSTK = 0;
 
// Put items into the stack
push(items);
 
return; };
 
// Destructors ============================================================== //
 
// -------------------------------------------------------------------------- //
template <class T>
LIFOStack<T>::~LIFOStack(
    void
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// DESTROY LIFO STACK                                                         //
// ========================================================================== //
 
// Maximal stack size
MAXSTK = 0;
 
// Current stack dimensions
TOPSTK = 0;
 
// Destroy items
STACK.clear();
 
return; };
 
// Methods ================================================================== //
 
// -------------------------------------------------------------------------- //
template <class T>
void LIFOStack<T>::clear(
    void
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// CLEAR CONTENT                                                              //
// ========================================================================== //
TOPSTK = 0;
STACK.resize(MAXSTK);
 
return; }
 
// -------------------------------------------------------------------------- //
template <class T>
void LIFOStack<T>::increaseSTACK(
    void
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// INCREASE STACK SIZE                                                        //
// ========================================================================== //
STACK.resize(STACK.size() + MAXSTK);
 
return; };
 
// -------------------------------------------------------------------------- //
template <class T>
void LIFOStack<T>::decreaseSTACK(
    void
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// DECREASE STACK SIZE                                                        //
// ========================================================================== //
STACK.resize(std::max((int) (STACK.size() - MAXSTK), MAXSTK));
 
return; };
 
// -------------------------------------------------------------------------- //
template <class T>
T LIFOStack<T>::pop(
    void
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
T       item;
 
// Counters
// none
 
// ========================================================================== //
// POP LAST ELEMENT FROM THE LIFO STACK                                       //
// ========================================================================== //
 
// Extract last element from the stack list --------------------------------- //
item = STACK[TOPSTK - 1];
TOPSTK--;
 
// Resize stack list -------------------------------------------------------- //
if (TOPSTK <= (long) STACK.size() - MAXSTK) {
    decreaseSTACK();
}
 
return(item); };
 
// -------------------------------------------------------------------------- //
template <class T>
void LIFOStack<T>::push(
    const T &item
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// POP LAST ELEMENT FROM THE LIFO STACK                                       //
// ========================================================================== //
 
// Resize stack list -------------------------------------------------------- //
if (TOPSTK >= (long) STACK.size()) {
    increaseSTACK();
}
 
// Extract last element from the stack list --------------------------------- //
STACK[TOPSTK] = item;
TOPSTK++;
 
return; };
 
// -------------------------------------------------------------------------- //
template <class T>
void LIFOStack<T>::push(
    const std::vector<T> &items
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
int            n_items;
 
// Counters
int            i;
 
// ========================================================================== //
// PUSH ITEMS INTO THE STACK                                                  //
// ========================================================================== //
n_items = items.size();
for (i = 0; i < n_items; i++) {
    push(items[i]);
} //next i
 
return; };
 
// -------------------------------------------------------------------------- //
template <class T>
void LIFOStack<T>::display(
    std::ostream &out
) {
 
// ========================================================================== //
// VARIABLES DECLARATION                                                      //
// ========================================================================== //
 
// Local variables
// none
 
// Counters
// none
 
// ========================================================================== //
// DISPLAY LIFO INFO                                                          //
// ========================================================================== //
out << "LIFO stack:" << std::endl;
out << "  n. of elements:      " << TOPSTK          << std::endl;
out << "  stack buffer:        " << MAXSTK          << std::endl;
out << "  data struct. size:   " << STACK.size()    << std::endl;
out << "  data: " << std::endl;
out << "[";
if (TOPSTK == 0) return;
for (int i = 0; i < TOPSTK-1; i++) {
    out << STACK[i] << ", ";
} //next i
out << STACK[TOPSTK-1] << "]" << std::endl;
 
return; };
 
}