PositionHeap.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/algorithm>
#include <ext/iostream>
 
#include <alib/string>
#include <alib/set>
#include <alib/trie>
 
#include <common/DefaultSymbolType.h>
 
#include <core/components.hpp>
#include <exception/CommonException.h>
 
#include <string/LinearString.h>
 
#include <indexes/common/IndexesNormalize.h>
 
namespace indexes {
 
namespace stringology {
 
class GeneralAlphabet;
 
template < class SymbolType = DefaultSymbolType >
class PositionHeap final {
    ext::trie < SymbolType, unsigned > m_trie;
 
    string::LinearString < SymbolType > m_string;
 
    void checkTrie ( const ext::trie < SymbolType, unsigned > & trie );
 
public:
    explicit PositionHeap ( ext::trie < SymbolType, unsigned > trie, string::LinearString < SymbolType > string );
 
    const ext::trie < SymbolType, unsigned > & getRoot ( ) const &;
 
    ext::trie < SymbolType, unsigned > && getRoot ( ) &&;
 
    const string::LinearString < SymbolType > & getString ( ) const &;
 
    string::LinearString < SymbolType > && getString ( ) &&;
 
    const ext::set < SymbolType > & getAlphabet ( ) const & {
        return m_string.getAlphabet ( );
    }
 
    ext::set < SymbolType > && getAlphabet ( ) && {
        return std::move ( m_string ).getAlphabet ( );
    }
 
    void setTree ( ext::trie < SymbolType, unsigned > trie );
 
    bool removeSymbolFromEdgeAlphabet ( const SymbolType & symbol ) {
        return m_string.removeSymbol ( symbol );
    }
 
    auto operator <=> ( const PositionHeap & other ) const {
        return std::tie ( getRoot ( ), getAlphabet ( ) ) <=> std::tie ( other.getRoot ( ), other.getAlphabet ( ) ); // indexed string does not need to be compared.
    }
 
    bool operator == ( const PositionHeap & other ) const {
        return std::tie ( getRoot ( ), getAlphabet ( ) ) == std::tie ( other.getRoot ( ), other.getAlphabet ( ) ); // indexed string does not need to be compared.
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const PositionHeap & instance ) {
        return out << "(PositionHeap " << instance.m_trie << ")";
    }
};
 
} /* namespace stringology */
 
} /* namespace indexes */
 
namespace indexes {
 
namespace stringology {
 
template < class SymbolType >
PositionHeap < SymbolType >::PositionHeap ( ext::trie < SymbolType, unsigned > trie, string::LinearString < SymbolType > string ) : m_trie ( std::move ( trie ) ), m_string ( std::move ( string ) ) {
    checkTrie ( this->m_trie );
}
 
template < class SymbolType >
void PositionHeap < SymbolType >::checkTrie ( const ext::trie < SymbolType, unsigned > & trie ) {
    for ( const std::pair < const SymbolType, ext::trie < SymbolType, 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, unsigned > & PositionHeap < SymbolType >::getRoot ( ) const & {
    return m_trie;
}
 
template < class SymbolType >
ext::trie < SymbolType, unsigned > && PositionHeap < SymbolType >::getRoot ( ) && {
    return std::move ( m_trie );
}
 
template < class SymbolType >
const string::LinearString < SymbolType > & PositionHeap < SymbolType >::getString ( ) const & {
    return m_string;
}
 
template < class SymbolType >
string::LinearString < SymbolType > && PositionHeap < SymbolType >::getString ( ) && {
    return std::move ( m_string );
}
 
template < class SymbolType >
void PositionHeap < SymbolType >::setTree ( ext::trie < SymbolType, unsigned > trie ) {
    checkTrie ( trie );
    this->m_trie = std::move ( trie ).clone ( );
}
 
} /* namespace stringology */
 
} /* namespace indexes */
 
namespace core {
 
template < class SymbolType >
struct normalize < indexes::stringology::PositionHeap < common::ranked_symbol < SymbolType > > > {
    static indexes::stringology::PositionHeap < common::ranked_symbol < DefaultSymbolType > > evalRanked ( indexes::stringology::PositionHeap < common::ranked_symbol < SymbolType > > && value ) {
        ext::trie < common::ranked_symbol < DefaultSymbolType >, unsigned > trie = indexes::IndexesNormalize::normalizeRankedTrie ( std::move ( value ).getRoot ( ) );
        string::LinearString < common::ranked_symbol < DefaultSymbolType > > string = normalize < string::LinearString < common::ranked_symbol < SymbolType > > >::eval ( std::move ( value ).getString ( ) );
 
        return indexes::stringology::PositionHeap < common::ranked_symbol < DefaultSymbolType > > ( std::move ( trie ), std::move ( string ) );
    }
 
    static indexes::stringology::PositionHeap < > eval ( indexes::stringology::PositionHeap < common::ranked_symbol < SymbolType > > && value ) {
        ext::trie < DefaultSymbolType, unsigned > trie = indexes::IndexesNormalize::normalizeTrie ( std::move ( value ).getRoot ( ) );
        string::LinearString < DefaultSymbolType > string = normalize < string::LinearString < SymbolType > >::eval ( std::move ( value ).getString ( ) );
 
        return indexes::stringology::PositionHeap < > ( std::move ( trie ), std::move ( string ) );
    }
};
 
template < class SymbolType >
struct normalize < indexes::stringology::PositionHeap < SymbolType > > {
    static indexes::stringology::PositionHeap < > eval ( indexes::stringology::PositionHeap < SymbolType > && value ) {
        ext::trie < DefaultSymbolType, unsigned > trie = indexes::IndexesNormalize::normalizeTrie ( std::move ( value ).getRoot ( ) );
        string::LinearString < DefaultSymbolType > string = normalize < string::LinearString < SymbolType > >::eval ( std::move ( value ).getString ( ) );
 
        return indexes::stringology::PositionHeap < > ( std::move ( trie ), std::move ( string ) );
    }
};
 
} /* namespace core */