// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2024, Knut Reinert, FU Berlin
// 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 Knut Reinert or the FU Berlin 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 KNUT REINERT OR THE FU BERLIN 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.
//
// ==========================================================================
// Author: David Weese <david.weese@fu-berlin.de>
// ==========================================================================

#ifndef SEQAN_HEADER_PUMP_LCP_H
#define SEQAN_HEADER_PUMP_LCP_H

namespace seqan2
{

//namespace seqan2_NAMESPACE_PIPELINING
//{

    struct LcpConfig
    {
        unsigned long   windowSize;
        bool            absoluteSizes;  // if false, sizes are measured in units of TValue
                                        // if true, sizes are measured in bytes

        LcpConfig():
            windowSize((sizeof(long) == 4)? 1ul << 30: 1ul << 31),
            absoluteSizes(true) {}

        template < typename TValue >
        void absolutize(TValue *) {
            if (!absoluteSizes) return;
            windowSize /= sizeof(TValue);
            if (windowSize < 4096) windowSize = 4096;
        }
    };



    template < typename TTextInput, typename TInvertedSAInput, typename TDest >
    static void _lcpProcess(TTextInput &textIn, TInvertedSAInput &invertedSAIn,
                            TDest &dest, LcpConfig conf)
    {
        typedef typename Value<TTextInput>::Type            TValue;
        typedef typename Size<TTextInput>::Type                TSize;
        typedef typename BufReadHandler<TTextInput>::Type    TBufReader;

        SEQAN_PROSET(SEQAN_PRODEPTH, 0);
        TSize rest = length(textIn);
        if (rest < 2) {
            resize(dest, 0);
            return;
        }

        // buffer is a window of textIn
        conf.absolutize((TValue*)NULL);
        TBufReader reader(textIn, conf.windowSize);

        Pair<TSize> out;
        TSize windowBegin = 0;
        TSize overlap = 0;
        TSize _pushes = 0;
        //TSize _olaps = 0;
        //char *seenISA = new bool[n];
        //memset(seenISA, 0, length(invertedSAIn));

        #ifdef SEQAN_DEBUG_INDEX
            TSize n = rest;
            TSize lcpMax = 0, lcpAvrg = 0, lcpNumer = 0, sigma = 1;    // for lcpMax, lcpMean, |Sigma|
        #endif

        resize(dest, rest);
        beginWrite(dest);
        // read the first block of textIn
        typename Value<TBufReader>::Type buffer = reader.first();
        while (length(buffer))
        {
            SEQAN_PROADD(SEQAN_PRODEPTH, 1);
            SEQAN_PROMARK("LCP-Durchlauf beginnen");
            beginRead(textIn);
            beginRead(invertedSAIn);

            out.i2 = 0;                                             // out.i2 == h
            TSize windowSize = length(buffer);
            TSize windowEnd = windowBegin + windowSize;
            TSize newOverlap = windowEnd;
            #ifdef SEQAN_DEBUG_INDEX
                std::cerr << std::hex << "  read window[" << windowBegin << "," << windowEnd;
                std::cerr << ") overlay " << overlap << " rest " << rest << std::dec << std::endl;
            #endif
            rest -= windowSize;

            //unsigned _pops = 0;

            while (!eof(invertedSAIn)) {

                if ((*invertedSAIn).i1 != 0) {

                    TSize left = (*invertedSAIn).i2[1] + out.i2;        // left == j + h

                    if (overlap <= (*invertedSAIn).i2[1] && left <= windowEnd) {
    //                        std::cerr << "* ";
                        for(; left < windowBegin; ++left) {
                            ++textIn;
                            ++out.i2;
                        }

                        TSize k = left - windowBegin;                   // k is relative to window
                        while (k < windowSize && (!eof(textIn)) && *textIn == buffer[k]) {
                            ++textIn;
                            ++k;
                        }
                        TSize hAdd = k - (left - windowBegin);
                        out.i2 += hAdd;                                 // increase h by successful compares
                        left += hAdd;

                        if (k != windowSize || rest == 0) {
                            out.i1 = (*invertedSAIn).i1 - 1;
                            push(dest, out);
                            //SEQAN_ASSERT(!seenISA[out.i1] && 0 <= out.i1 && out.i1 < n);
                            //seen[out.i1] = true;
                            ++_pushes;

                            #ifdef SEQAN_DEBUG_INDEX
                                if ((lcpNumer += out.i2) > n) {
                                    lcpNumer -= n;
                                    ++lcpAvrg;
                                }
                                if (lcpMax < out.i2) lcpMax = out.i2;
                                if (!out.i2) ++sigma;
                            #endif
                        }
                    }

                    if (left >= windowEnd && (*invertedSAIn).i2[1] < newOverlap) {
                        #ifdef SEQAN_VERBOSE
                            std::cerr << "crossing border @ " << (*invertedSAIn).i2[1] << " len " << out.i2 << std::endl;
                        #endif
                        newOverlap = (*invertedSAIn).i2[1];    //++_olaps;
                    }
                }

                if (out.i2) --out.i2;                               // if (h > 0) h = h - 1
                else ++textIn;

                ++invertedSAIn; //++_pops;
            }

            endRead(invertedSAIn);
            endRead(textIn);

            windowBegin = windowEnd;
            overlap = newOverlap;
            buffer = reader.next();                                 // read the following block

            //std::cerr << "pops:" << _pops << " pushes:" << _pushes << " overlaps:" << _olaps << std::endl;
        }
        // trailing zero
        push(dest, Pair<TSize>(length(textIn) - 1, 0));

        //std::cerr << "pushes:" << _pushes << " length:" << length(textIn) << std::endl;
        //SEQAN_ASSERT_EQ(_pushes, length(textIn));
        //for (unsigned i = 0; i < n; ++i)
        //    if (!seen[i])
        //        std::cerr << "___" << i << "______HUH?" << std::endl;
        //delete[] seenISA;

        #ifdef SEQAN_DEBUG_INDEX
            std::cerr << "  n: " << n;
            std::cerr << "  lcpMax: " << lcpMax;
            std::cerr << "  lcpAvrg: " << lcpAvrg + lcpNumer / (double)n;
            std::cerr << "  sigma: " << sigma << std::endl;
        #endif

//TODO: uncomment this line
//        reader.end();
        endWrite(dest);
        SEQAN_PROSET(SEQAN_PRODEPTH, 0);
    }

    template < typename TTextInput, typename TInvertedSAInput, typename TDest >
    static inline void _lcpProcess(TTextInput &textIn, TInvertedSAInput &invertedSAIn, TDest &dest)
    {
        _lcpProcess(textIn, invertedSAIn, dest, LcpConfig());
    }

//////////////////////////////////////////////////////////////////////////////


    template < typename TTextInput, typename TLimitsString, typename TInvertedSAInput, typename TDest >
    static void _lcpProcessMulti(
        TTextInput &textIn, TLimitsString const &limits,
        TInvertedSAInput &invertedSAIn,
        TDest &dest, LcpConfig conf)
    {
        typedef typename Value<TTextInput>::Type            TValue;
        typedef typename Size<TTextInput>::Type                TSize;
        typedef typename BufReadHandler<TTextInput>::Type    TBufReader;

        //typedef typename Value<typename Value<typename Value<TInvertedSAInput>::Type, 2>::Type>::Type TPair;

        SEQAN_PROSET(SEQAN_PRODEPTH, 0);
        TSize rest = length(textIn);
        if (rest < 2) {
            resize(dest, 0);
            return;
        }

        // buffer is a window of textIn
        conf.absolutize((TValue*)NULL);
        TBufReader reader(textIn, conf.windowSize);

        Pair<TSize> out;
        TSize windowBegin = 0;
        TSize overlap = 0;
        TSize _pushes = 0;
        //TSize _olaps = 0;
        //char *seenISA = new bool[n];
        //memset(seenISA, 0, length(invertedSAIn));

        #ifdef SEQAN_DEBUG_INDEX
            TSize n = rest;
            TSize lcpMax = 0, lcpAvrg = 0, lcpNumer = 0, sigma = 1;    // for lcpMax, lcpMean, |Sigma|
        #endif

        resize(dest, rest);
        beginWrite(dest);
        // read the first block of textIn
        typename Value<TBufReader>::Type buffer = reader.first();
        while (length(buffer))
        {
            SEQAN_PROADD(SEQAN_PRODEPTH, 1);
            SEQAN_PROMARK("LCP-Durchlauf beginnen");

            beginRead(textIn);
            beginRead(invertedSAIn);

            out.i2 = 0;                                             // out.i2 == h
            TSize windowSize = length(buffer);
            TSize windowEnd = windowBegin + windowSize;
            TSize newOverlap = windowEnd;
            #ifdef SEQAN_DEBUG_INDEX
                std::cerr << std::hex << "  read window[" << windowBegin << "," << windowEnd;
                std::cerr << ") overlay " << overlap << " rest " << rest << std::dec << " size:"<< sizeof(TSize)<<std::endl;
            #endif
            rest -= windowSize;

            //unsigned _pops = 0;

            TSize leftOrig, left;        // begin and begin + seen_lcp of the lower string (global)

            while (!eof(invertedSAIn)) {

                if ((*invertedSAIn).i1 != 0) {

                    leftOrig = posGlobalize((*invertedSAIn).i2[1], limits);
                    left = leftOrig + out.i2;        // left == j + h

                    if (overlap <= leftOrig && left <= windowEnd) {
    //                        std::cerr << "* ";
                        for(; left < windowBegin; ++left) {
                            ++textIn;
                            ++out.i2;
                        }

                        // end of lower string relative to window
                        TSize kEnd = limits[getValueI1((*invertedSAIn).i2[1]) + 1] - windowBegin;
                        if (kEnd > windowSize) kEnd = windowSize;

                        TSize k = left - windowBegin;                        // k is relative to window

                        // comparision will break before the end of the upper string
                        // -> only lower string needs a clipping

                        while (k < kEnd && (!eof(textIn)) && *textIn == buffer[k]) {
                            ++textIn;
                            ++k;
                        }
                        TSize hAdd = k - (left - windowBegin);
                        out.i2 += hAdd;                                 // increase h by successful compares
                        left += hAdd;

                        if (k != windowSize || rest == 0) {
                            out.i1 = (*invertedSAIn).i1 - 1;
                            push(dest, out);
                            //SEQAN_ASSERT(!seenISA[out.i1] && 0 <= out.i1 && out.i1 < n);
                            //seen[out.i1] = true;
                            ++_pushes;

                            #ifdef SEQAN_DEBUG_INDEX
                                if ((lcpNumer += out.i2) > n) {
                                    lcpNumer -= n;
                                    ++lcpAvrg;
                                }
                                if (lcpMax < out.i2) lcpMax = out.i2;
                                if (!out.i2) ++sigma;
                            #endif
                        }
                    }

                    if (left >= windowEnd && leftOrig < newOverlap) {
                        #ifdef SEQAN_VERBOSE
                            std::cerr << "crossing border @ " << (*invertedSAIn).i2[1] << " len " << out.i2 << std::endl;
                        #endif
                        newOverlap = leftOrig;    //++_olaps;
                    }
                }

                if (out.i2)
                    --out.i2;                               // if (h > 0) h = h - 1
                else
                    ++textIn;

                ++invertedSAIn; //++_pops;
            }

            endRead(invertedSAIn);
            endRead(textIn);

            windowBegin = windowEnd;
            overlap = newOverlap;
            buffer = reader.next();                                 // read the following block

            //std::cerr << "pops:" << _pops << " pushes:" << _pushes << " overlaps:" << _olaps << std::endl;
        }
        // trailing zero
        push(dest, Pair<TSize>(length(textIn) - 1, 0));

        //std::cerr << "pushes:" << _pushes << " length:" << length(textIn) << std::endl;
        //SEQAN_ASSERT_EQ(_pushes, length(textIn));
        //for (unsigned i = 0; i < n; ++i)
        //    if (!seen[i])
        //        std::cerr << "___" << i << "______HUH?" << std::endl;
        //delete[] seenISA;

        #ifdef SEQAN_DEBUG_INDEX
            std::cerr << "  n: " << n;
            std::cerr << "  lcpMax: " << lcpMax;
            std::cerr << "  lcpAvrg: " << lcpAvrg + lcpNumer / (double)n;
            std::cerr << "  sigma: " << sigma << std::endl;
        #endif

//TODO: uncomment this line
//        reader.end();
        endWrite(dest);
        SEQAN_PROSET(SEQAN_PRODEPTH, 0);
    }

    template < typename TTextInput, typename TLimitsString, typename TInvertedSAInput, typename TDest >
    static void _lcpProcessMulti(
        TTextInput &textIn, TLimitsString const &limits,
        TInvertedSAInput &invertedSAIn,
        TDest &dest)
    {
        _lcpProcessMulti(textIn, limits, invertedSAIn, dest, LcpConfig());
    }



//}

}

#endif
