// ==========================================================================
//                 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: Andreas Gogol-Doering <andreas.doering@mdc-berlin.de>
// ==========================================================================

#ifndef SEQAN_HEADER_FIND_BNDMALGO_H
#define SEQAN_HEADER_FIND_BNDMALGO_H

namespace seqan2
{

//////////////////////////////////////////////////////////////////////////////
// BndmAlgo
//////////////////////////////////////////////////////////////////////////////

/*!
 * @class BndmAlgoPattern
 * @extends Pattern
 * @headerfile <seqan/find.h>
 * @brief Backward Nondeterministic Dawg Matching algorithm.  Exact string matching using bit parallelism.
 *
 * @signature template <typename TNeedle>
 *            class Pattern<TNeedle, BndmAlgo>;
 *
 * @tparam TNeedle The needle type.  Types: String
 *
 * The types of the needle and the haystack have to match.
 */

struct BndmAlgo_;
typedef Tag<BndmAlgo_> BndmAlgo;

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

template <typename TNeedle>
class Pattern<TNeedle, BndmAlgo> {
//____________________________________________________________________________
public:
    typedef unsigned int TWord;

    Holder<TNeedle> data_host;
    String<TWord> table;            // Look up table for each character in the alphabet (called B in "Navarro")
    String<TWord> activeFactors;    // The active factors in the pattern (called D in "Navarro")
    TWord needleLength;                // e.g., needleLength=33 --> blockCount=2 (iff w=32 bits)
    TWord haystackLength;            // Length of haystack
    TWord blockCount;                // #unsigned ints required to store needle
    TWord last;

//____________________________________________________________________________

    Pattern() {}

    template <typename TNeedle2>
    Pattern(TNeedle2 && ndl,
            SEQAN_CTOR_DISABLE_IF(IsSameType<typename std::remove_reference<TNeedle2>::type const &, Pattern const &>))
    {
        setHost(*this, std::forward<TNeedle2>(ndl));
        ignoreUnusedVariableWarning(dummy);
    }

//____________________________________________________________________________
};


//////////////////////////////////////////////////////////////////////////////
// Functions
//////////////////////////////////////////////////////////////////////////////

template <typename TNeedle>
void _reinitPattern(Pattern<TNeedle, BndmAlgo> & me) {
    typedef unsigned int TWord;
    typedef typename Value<TNeedle>::Type TValue;

    me.needleLength = length(needle(me));
    if (me.needleLength<1) me.blockCount=1;
    else me.blockCount=((me.needleLength-1) / BitsPerValue<TWord>::VALUE)+1;

    clear(me.table);
    resize(me.table, me.blockCount * ValueSize<TValue>::VALUE, 0, Exact());

    for (TWord j = 0; j < me.needleLength; ++j) {
        // Determine character position in array table
        TWord pos = convert<TWord>(getValue(needle(me),j));
        me.table[me.blockCount*pos + j / BitsPerValue<TWord>::VALUE] |= (1<<(j%BitsPerValue<TWord>::VALUE));
    }
    /*
    // Debug code
    std::cout << "Alphabet size: " << ValueSize<TValue>::VALUE << std::endl;
    std::cout << "Needle length: " << me.needleLength << std::endl;
    std::cout << "Block count: " << me.blockCount << std::endl;

    for(unsigned int i=0;i<ValueSize<TValue>::VALUE;++i) {
        if ((i<97) || (i>122)) continue;
        std::cout << static_cast<char>(i) << ": ";
        for(int j=0;j<me.blockCount;++j) {
            for(int bit_pos=0;bit_pos<BitsPerValue<unsigned int>::VALUE;++bit_pos) {
                std::cout << ((me.table[me.blockCount*i+j] & (1<<(bit_pos % BitsPerValue<unsigned int>::VALUE))) !=0);
            }
        }
        std::cout << std::endl;
    }
    */
}

//____________________________________________________________________________


template <typename TNeedle>
inline void _patternInit (Pattern<TNeedle, BndmAlgo> & me)
{
    clear(me.activeFactors);
    resize(me.activeFactors, me.blockCount, 0, Exact());
    me.last = 0;
}


//____________________________________________________________________________


template <typename TFinder, typename TNeedle>
inline bool _findBndmSmallNeedle(TFinder & finder,
                                  Pattern<TNeedle, BndmAlgo> & me) {
    typedef unsigned int TWord;
    typedef typename Value<TNeedle>::Type TNeedleAlphabet;

    if (me.haystackLength < me.needleLength) return false;
    while (position(finder) <= me.haystackLength - me.needleLength)
    {
        me.last=me.needleLength;
        TWord j=me.needleLength;
        me.activeFactors[0]=~0;
        while (me.activeFactors[0]!=0)
        {
            TWord pos = convert<TWord>(convert<TNeedleAlphabet>(*(finder+j-1)));
            me.activeFactors[0] = (me.activeFactors[0] & me.table[me.blockCount*pos]);
            j--;
            if ((me.activeFactors[0] & 1) != 0)
            {
                if (j>0) me.last=j;
                else
                {
                    _setFinderEnd(finder, position(finder) + me.needleLength);
                    return true;
                }
            }
            me.activeFactors[0] = me.activeFactors[0] >> 1;
        }
        finder+=me.last;
    }
    return false;
}

template <typename TFinder, typename TNeedle>
inline bool _findBndmLargeNeedle(TFinder & finder, Pattern<TNeedle, BndmAlgo> & me) {
    typedef unsigned int TWord;
    typedef typename Value<TNeedle>::Type TNeedleAlphabet;

    TWord carryPattern = ((TWord)1 << (BitsPerValue<TWord>::VALUE - 1));
    while (position(finder) <= me.haystackLength - me.needleLength) {
        me.last=me.needleLength;
        TWord j=me.needleLength;
        for(TWord block=0;block<me.blockCount;++block) me.activeFactors[block]=~0;
        bool zeroPrefSufMatch = false;
        while (!zeroPrefSufMatch) {
            TWord pos = convert<TWord>(convert<TNeedleAlphabet>(*(finder+j-1)));

            /*
            // Debug code
            std::cout << "   ";
            for(int j=0;j<me.blockCount;++j) {
                for(int bit_pos=0;bit_pos<BitsPerValue<unsigned int>::VALUE;++bit_pos) {
                    std::cout << ((me.activeFactors[j] & (1<<(bit_pos % BitsPerValue<unsigned int>::VALUE))) !=0);
                }
            }
            std::cout << std::endl;
            */

            for(TWord block=0;block<me.blockCount;++block) me.activeFactors[block] &= me.table[me.blockCount*pos+block];
            j--;
            if ((me.activeFactors[0] & 1) != 0)
            {
                if (j>0) me.last=j;
                else
                {
                    _setFinderEnd(finder, position(finder) + me.needleLength);
                    return true;
                }
            }
            bool carry=0;
            zeroPrefSufMatch=true;
            for(int block=me.blockCount-1;block>=0;--block) {
                bool newCarry=((me.activeFactors[block] & 1)!=0);
                me.activeFactors[block]>>=1;
                if (carry) me.activeFactors[block]|=carryPattern;
                carry=newCarry;
                if (me.activeFactors[block]!=0) zeroPrefSufMatch=false;
            }
        }
        finder+=me.last;
    }
    return false;
}

template <typename TFinder, typename TNeedle>
inline bool find(TFinder & finder, Pattern<TNeedle, BndmAlgo> & me) {

    if (empty(finder)) {
        _patternInit(me);
        _setFinderLength(finder, length(needle(me)));
        _finderSetNonEmpty(finder);
        me.haystackLength = length(container(finder));
    } else
        finder+=me.last;

    // Fast algorithm for needles < machine word?
    if (me.blockCount == 1) {
        return _findBndmSmallNeedle(finder, me);
    } else {
        return _findBndmLargeNeedle(finder, me);
    }
}

}// namespace seqan2

#endif //#ifndef SEQAN_HEADER_FIND_SHIFTAND_H
