sort_deprecated.h

Go to the documentation of this file.

// -*- mode: c++; tab-width: 4; indent-tabs-mode: t; c-file-style: "stroustrup"; -*-
// vi:set ts=4 sts=4 sw=4 noet :
// Copyright 2008-2012, The TPIE development team
// 
// This file is part of TPIE.
// 
// TPIE is free software: you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the
// Free Software Foundation, either version 3 of the License, or (at your
// option) any later version.
// 
// TPIE 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 TPIE.  If not, see <http://www.gnu.org/licenses/>

#ifndef __TPIE_SORT_DEPRECATED_H__
#define __TPIE_SORT_DEPRECATED_H__


// Get definitions for working with Unix and Windows
#include <tpie/portability.h>

// The class that actually does the sorting
#include <tpie/sort_manager.h>
#include <tpie/mergeheap.h>
#include <tpie/internal_sort.h>

#include <tpie/progress_indicator_base.h>
#include <tpie/progress_indicator_null.h>

#include <tpie/sort.h>

#include <tpie/comparator.h>

namespace tpie {

    namespace ami {
        inline err exception_kind(const exception & e) {
            if (0 != dynamic_cast<const end_of_stream_exception *>(&e)) return END_OF_STREAM;
            return BTE_ERROR;
        }
    }

    namespace ami {

    template<class T>
    err sort(stream<T> *instream_ami, stream<T> *outstream_ami,
         tpie::progress_indicator_base* indicator=NULL) {
        try {
            tpie::sort(instream_ami->underlying_stream(), outstream_ami->underlying_stream(), indicator);
        } catch (const exception & e) {
            TP_LOG_FATAL_ID(e.what());
            return exception_kind(e);
        }
        return NO_ERROR;
    }

    }


  namespace ami {
  template<class T, class CMPR>
  err sort(stream<T> *instream_ami, stream<T> *outstream_ami,
         CMPR *cmp, progress_indicator_base* indicator=NULL) {
        try {
            TPIE2STL_cmp<T, CMPR> comp(cmp);
            if (indicator) {
                tpie::sort(instream_ami->underlying_stream(), outstream_ami->underlying_stream(), comp, *indicator);
            } else {
                progress_indicator_null dummy(1);
                tpie::sort(instream_ami->underlying_stream(), outstream_ami->underlying_stream(), comp, dummy);
            }
        } catch (const exception & e) {
            TP_LOG_FATAL_ID(e.what());
            return exception_kind(e);
        }
        return NO_ERROR;
    }
  }

// --------------------------------------------------------------------
// -                                                                  -
// -  These versions used to build a heap on pointers to objects      -
// -  but have been deprecated, since they have been broken for       -
// -  many years and caused unnecessary code duplication.             -
// -                                                                  -
// --------------------------------------------------------------------

    namespace ami {
    template<class T>
    err ptr_sort(stream<T> *instream_ami, stream<T> *outstream_ami,
               progress_indicator_base* indicator=NULL) {

        TP_LOG_WARNING_ID("tpie::ami::ptr_sort is deprecated");
        return sort(instream_ami, outstream_ami, indicator);
    }
    }
    
    namespace ami {
    template<class T, class CMPR>
    err ptr_sort(stream<T> *instream_ami, stream<T> *outstream_ami,
             CMPR *cmp, progress_indicator_base* indicator=NULL) {
        TP_LOG_WARNING_ID("tpie::ami::ptr_sort is deprecated");
        return sort(instream_ami, outstream_ami, cmp, indicator);
    }
    }

// ********************************************************************
// *                                                                  *
// *  This version used to keep a heap of keys and pointers, but has  *
// *  been deprecated since nobody uses it.                           *
// *                                                                  *
// ********************************************************************

    namespace ami {
    template<class T, class KEY, class CMPR>
    err  key_sort(stream<T> *instream_ami, stream<T> *outstream_ami,
              KEY, CMPR *cmp, progress_indicator_base* indicator=NULL)  {
        TP_LOG_WARNING_ID("tpie::ami::key_sort is deprecated");
        return sort(instream_ami, outstream_ami, cmp, indicator);
    }
    }

// ********************************************************************
// *                                                                  *
// * Duplicates of the above versions that only use 2x space and      *
// * overwrite the original input stream                              *
// *                                                                  *
// ********************************************************************/

    namespace ami {
    template<class T>
    err sort(stream<T> *instream_ami, 
         progress_indicator_base* indicator=0) {
        try {
            if (indicator) {
                tpie::sort(instream_ami->underlying_stream(), *indicator);
            } else {
                progress_indicator_null dummy(1);
                tpie::sort(instream_ami->underlying_stream(), dummy);
            }
        } catch (const exception & e) {
            TP_LOG_FATAL_ID(e.what());
            return exception_kind(e);
        }
        return NO_ERROR;
    }
    }
    

    namespace ami {
    template<class T, class CMPR>
    err sort(stream<T> *instream_ami, 
         CMPR *cmp, progress_indicator_base* indicator=NULL) {
        try {
            TPIE2STL_cmp<T, CMPR> comp(cmp);
            if (indicator) {
                tpie::sort(instream_ami->underlying_stream(), comp, *indicator);
            } else {
                progress_indicator_null dummy(1);
                tpie::sort(instream_ami->underlying_stream(), comp, dummy);
            }
        } catch (const exception & e) {
            TP_LOG_FATAL_ID(e.what());
            return exception_kind(e);
        }
        return NO_ERROR;
    }
    }

    namespace ami {
    template<class T>
    err ptr_sort(stream<T> *instream_ami, 
             progress_indicator_base* indicator=NULL) {
        TP_LOG_WARNING_ID("tpie::ami::ptr_sort is deprecated");
        return sort(instream_ami, indicator);
    }
    }

    namespace ami {
    template<class T, class CMPR>
    err ptr_sort(stream<T> *instream_ami, 
             CMPR *cmp, progress_indicator_base* indicator=NULL) {
        TP_LOG_WARNING_ID("tpie::ami::ptr_sort is deprecated");
        return sort(instream_ami, cmp, indicator);
    }
    }

    namespace ami {
    template<class T, class KEY, class CMPR>
    err  key_sort(stream<T> *instream_ami, 
              KEY /*dummykey*/, CMPR *cmp, progress_indicator_base* indicator=NULL) {
        TP_LOG_WARNING_ID("tpie::ami::key_sort is deprecated");
        return sort(instream_ami, cmp, indicator);
    }
    }

}  //  tpie namespace


#endif // __TPIE_SORT_DEPRECATED_H__