SuffixTrie.h

Go to the documentation of this file.

 
/*
 * This file is part of Algorithms library toolkit.
 * Copyright (C) 2017 Jan Travnicek (jan.travnicek@fit.cvut.cz)
 
 * Algorithms library toolkit is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 
 * Algorithms library toolkit 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 General Public License for more details.
 
 * You should have received a copy of the GNU General Public License
 * along with Algorithms library toolkit.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <ext/iostream>
#include <ext/algorithm>
 
#include <alib/string>
#include <alib/set>
#include <alib/trie>
#include <alib/optional>
 
#include <common/DefaultSymbolType.h>
 
#include <core/components.hpp>
#include <exception/CommonException.h>
 
#include <core/normalize.hpp>
#include <alphabet/common/SymbolNormalize.h>
#include <indexes/common/IndexesNormalize.h>
 
namespace indexes {
 
namespace stringology {
 
class GeneralAlphabet;
 
template < class SymbolType = DefaultSymbolType >
class SuffixTrie final : public core::Components < SuffixTrie < SymbolType >, ext::set < SymbolType >, component::Set, GeneralAlphabet > {
    ext::trie < SymbolType, std::optional < unsigned > > m_trie;
 
    void checkTrie ( const ext::trie < SymbolType, std::optional < unsigned > > & trie );
 
public:
    explicit SuffixTrie ( ext::set < SymbolType > edgeAlphabet );
 
    explicit SuffixTrie ( ext::set < SymbolType > edgeAlphabet, ext::trie < SymbolType, std::optional < unsigned > > trie );
 
    explicit SuffixTrie ( ext::trie < SymbolType, std::optional < unsigned > > trie );
 
    const ext::trie < SymbolType, std::optional < unsigned > > & getRoot ( ) const &;
 
    ext::trie < SymbolType, std::optional < unsigned > > && getRoot ( ) &&;
 
    const ext::set < SymbolType > & getAlphabet ( ) const & {
        return this->template accessComponent < GeneralAlphabet > ( ).get ( );
    }
 
    ext::set < SymbolType > && getAlphabet ( ) && {
        return std::move ( this->template accessComponent < GeneralAlphabet > ( ).get ( ) );
    }
 
    void setTree ( ext::trie < SymbolType, std::optional < unsigned > > trie );
 
    bool removeSymbolFromEdgeAlphabet ( const SymbolType & symbol ) {
        return this->template accessComponent < GeneralAlphabet > ( ).remove ( symbol );
    }
 
    auto operator <=> ( const SuffixTrie & other ) const {
        return std::tie ( getRoot ( ), getAlphabet ( ) ) <=> std::tie ( other.getRoot ( ), other.getAlphabet ( ) );
    }
 
    bool operator == ( const SuffixTrie & other ) const {
        return std::tie ( getRoot ( ), getAlphabet ( ) ) == std::tie ( other.getRoot ( ), other.getAlphabet ( ) );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const SuffixTrie & instance ) {
        return out << "(SuffixTrie " << instance.m_trie << ")";
    }
};
 
} /* namespace stringology */
 
} /* namespace indexes */
 
namespace indexes {
 
namespace stringology {
 
template < class SymbolType >
SuffixTrie < SymbolType >::SuffixTrie ( ext::set < SymbolType > edgeAlphabet ) : SuffixTrie ( std::move ( edgeAlphabet ), ext::trie < SymbolType, std::optional < unsigned > > ( std::optional < unsigned > ( ) ) ) {
}
 
template < class SymbolType >
SuffixTrie < SymbolType >::SuffixTrie ( ext::set < SymbolType > edgeAlphabet, ext::trie < SymbolType, std::optional < unsigned > > trie ) : core::Components < SuffixTrie, ext::set < SymbolType >, component::Set, GeneralAlphabet > ( std::move ( edgeAlphabet ) ), m_trie ( std::move ( trie ) ) {
    checkTrie ( this->m_trie );
}
 
template < class SymbolType >
SuffixTrie < SymbolType >::SuffixTrie ( ext::trie < SymbolType, std::optional < unsigned > > trie ) : SuffixTrie ( computeMinimalEdgeAlphabet ( trie ), trie ) {
}
 
template < class SymbolType >
void SuffixTrie < SymbolType >::checkTrie ( const ext::trie < SymbolType, std::optional < unsigned > > & trie ) {
    for ( const std::pair < const SymbolType, ext::trie < SymbolType, std::optional < unsigned > > > & child : trie.getChildren ( ) ) {
        if ( ! getAlphabet ( ).count ( child.first ) )
            throw exception::CommonException ( "Symbol " + ext::to_string ( child.first ) + "not in the alphabet." );
        checkTrie ( child.second );
    }
}
 
template < class SymbolType >
const ext::trie < SymbolType, std::optional < unsigned > > & SuffixTrie < SymbolType >::getRoot ( ) const & {
    return m_trie;
}
 
template < class SymbolType >
ext::trie < SymbolType, std::optional < unsigned > > && SuffixTrie < SymbolType >::getRoot ( ) && {
    return std::move ( m_trie );
}
 
template < class SymbolType >
void SuffixTrie < SymbolType >::setTree ( ext::trie < SymbolType, std::optional < unsigned > > trie ) {
    checkTrie ( trie );
    this->m_trie = std::move ( trie ).clone ( );
}
 
} /* namespace stringology */
 
} /* namespace indexes */
 
namespace core {
 
template < class SymbolType >
class SetConstraint < indexes::stringology::SuffixTrie < SymbolType >, SymbolType, indexes::stringology::GeneralAlphabet > {
 
    static bool used ( const ext::trie < SymbolType, std::optional < unsigned > > & trie, const SymbolType & symbol ) {
        for ( const std::pair < const SymbolType, ext::trie < SymbolType, std::optional < unsigned > > > & child : trie.getChildren ( ) ) {
            if ( symbol == child.first || checkTrie ( trie, child.second ) )
                return true;
        }
        return false;
    }
 
public:
    static bool used ( const indexes::stringology::SuffixTrie < SymbolType > & index, const SymbolType & symbol ) {
        return used ( index.getRoot ( ), symbol );
    }
 
    static bool available ( const indexes::stringology::SuffixTrie < SymbolType > &, const SymbolType & ) {
        return true;
    }
 
    static void valid ( const indexes::stringology::SuffixTrie < SymbolType > &, const SymbolType & ) {
    }
};
 
template < class SymbolType >
struct normalize < indexes::stringology::SuffixTrie < SymbolType > > {
    static indexes::stringology::SuffixTrie < > eval ( indexes::stringology::SuffixTrie < SymbolType > && value ) {
        ext::set < DefaultSymbolType > alphabet = alphabet::SymbolNormalize::normalizeAlphabet ( std::move ( value ).getAlpahet ( ) );
        ext::trie < DefaultSymbolType, std::optional < unsigned > > trie = indexes::IndexesNormalize::normalizeTrie ( std::move ( value ).getRoot ( ) );
 
        return indexes::stringology::SuffixTrie < > ( std::move ( alphabet ), std::move ( trie ) );
    }
};
 
} /* namespace core */