PrefixRankedBarTree.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 <common/DefaultSymbolType.h>
 
namespace tree {
 
template < class SymbolType = DefaultSymbolType >
class PrefixRankedBarTree;
 
} /* namespace tree */
 
 
#include <ext/algorithm>
 
#include <alib/set>
#include <alib/vector>
#include <alib/tree>
#include <alib/deque>
 
#include <core/components.hpp>
#include <common/ranked_symbol.hpp>
 
#include <tree/TreeException.h>
#include <tree/common/TreeAuxiliary.h>
 
#include <alphabet/BarSymbol.h>
 
#include <core/normalize.hpp>
#include <tree/common/TreeNormalize.h>
 
#include <string/LinearString.h>
 
#include "RankedTree.h"
 
namespace tree {
 
class GeneralAlphabet;
class BarSymbols;
 
template < class SymbolType >
class PrefixRankedBarTree final : public core::Components < PrefixRankedBarTree < SymbolType >, ext::set < common::ranked_symbol < SymbolType > >, component::Set, std::tuple < GeneralAlphabet, BarSymbols > > {
    ext::vector < common::ranked_symbol < SymbolType > > m_Data;
 
    void arityChecksum ( const ext::vector < common::ranked_symbol < SymbolType > > & data );
 
public:
    explicit PrefixRankedBarTree ( ext::set < common::ranked_symbol < SymbolType > > bars, ext::set < common::ranked_symbol < SymbolType > > alphabet, ext::vector < common::ranked_symbol < SymbolType > > data );
 
    explicit PrefixRankedBarTree ( ext::set < common::ranked_symbol < SymbolType > > bars, ext::vector < common::ranked_symbol < SymbolType > > data );
 
    explicit PrefixRankedBarTree ( SymbolType barBase, const RankedTree < SymbolType > & tree );
 
    explicit PrefixRankedBarTree ( const RankedTree < > & tree );
 
    const ext::set < common::ranked_symbol < SymbolType > > & getAlphabet ( ) const & {
        return this->template accessComponent < GeneralAlphabet > ( ).get ( );
    }
 
    ext::set < common::ranked_symbol < SymbolType > > && getAlphabet ( ) && {
        return std::move ( this->template accessComponent < GeneralAlphabet > ( ).get ( ) );
    }
 
    void extendAlphabet ( const ext::set < common::ranked_symbol < SymbolType > > & symbols ) {
        this->template accessComponent < GeneralAlphabet > ( ).add ( symbols );
    }
 
    const ext::set < common::ranked_symbol < SymbolType > > & getBars ( ) const & {
        return this->template accessComponent < BarSymbols > ( ).get ( );
    }
 
    ext::set < common::ranked_symbol < SymbolType > > && getBars ( ) && {
        return std::move ( this->template accessComponent < BarSymbols > ( ).get ( ) );
    }
 
    void extendBars ( const ext::set < common::ranked_symbol < SymbolType > > & bars ) {
        this->template accessComponent < BarSymbols > ( ).add ( bars );
    }
 
    const ext::vector < common::ranked_symbol < SymbolType > > & getContent ( ) const &;
 
    ext::vector < common::ranked_symbol < SymbolType > > && getContent ( ) && ;
 
    void setContent ( ext::vector < common::ranked_symbol < SymbolType > > data );
 
    bool isEmpty ( ) const;
 
    auto operator <=> ( const PrefixRankedBarTree & other ) const {
        return std::tie ( m_Data, getAlphabet(), getBars() ) <=> std::tie ( other.m_Data, other.getAlphabet(), other.getBars() );
    }
 
    bool operator == ( const PrefixRankedBarTree & other ) const {
        return std::tie ( m_Data, getAlphabet(), getBars() ) == std::tie ( other.m_Data, other.getAlphabet(), other.getBars() );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const PrefixRankedBarTree & instance ) {
        out << "(PrefixRankedBarTree";
        out << " alphabet = " << instance.getAlphabet ( );
        out << " bars = " << instance.getBars ( );
        out << " content = " << instance.getContent ( );
        out << ")";
        return out;
    }
 
    explicit operator string::LinearString < common::ranked_symbol < SymbolType > > ( ) const {
        return string::LinearString < common::ranked_symbol < SymbolType > > ( getAlphabet ( ), getContent ( ) );
    }
};
 
template < class SymbolType >
PrefixRankedBarTree < SymbolType >::PrefixRankedBarTree ( ext::set < common::ranked_symbol < SymbolType > > bars, ext::set < common::ranked_symbol < SymbolType > > alphabet, ext::vector < common::ranked_symbol < SymbolType > > data ) : core::Components < PrefixRankedBarTree, ext::set < common::ranked_symbol < SymbolType > >, component::Set, std::tuple < GeneralAlphabet, BarSymbols > > ( std::move ( alphabet ), std::move ( bars ) ) {
    setContent ( std::move ( data ) );
}
 
template < class SymbolType >
PrefixRankedBarTree < SymbolType >::PrefixRankedBarTree ( ext::set < common::ranked_symbol < SymbolType > > bars, ext::vector < common::ranked_symbol < SymbolType > > data ) : PrefixRankedBarTree ( bars, bars + ext::set < common::ranked_symbol < SymbolType > > ( data.begin ( ), data.end ( ) ), data ) {
}
 
template < class SymbolType >
PrefixRankedBarTree < SymbolType >::PrefixRankedBarTree ( SymbolType barBase, const RankedTree < SymbolType > & tree ) : PrefixRankedBarTree ( TreeAuxiliary::computeBars ( tree.getAlphabet ( ), barBase ), tree.getAlphabet ( ) + TreeAuxiliary::computeBars ( tree.getAlphabet ( ), barBase ), TreeAuxiliary::treeToPrefix ( tree.getContent ( ), barBase ) ) {
}
 
template < class SymbolType >
PrefixRankedBarTree < SymbolType >::PrefixRankedBarTree ( const RankedTree < > & tree ) : PrefixRankedBarTree ( alphabet::BarSymbol::instance < SymbolType > ( ), tree ) {
}
 
template < class SymbolType >
const ext::vector < common::ranked_symbol < SymbolType > > & PrefixRankedBarTree < SymbolType >::getContent ( ) const & {
    return this->m_Data;
}
 
template < class SymbolType >
ext::vector < common::ranked_symbol < SymbolType > > && PrefixRankedBarTree < SymbolType >::getContent ( ) && {
    return std::move ( this->m_Data );
}
 
template < class SymbolType >
void PrefixRankedBarTree < SymbolType >::setContent ( ext::vector < common::ranked_symbol < SymbolType > > data ) {
    arityChecksum ( data );
 
    ext::set < common::ranked_symbol < SymbolType > > minimalAlphabet ( data.begin ( ), data.end ( ) );
    std::set_difference ( minimalAlphabet.begin ( ), minimalAlphabet.end ( ), getAlphabet ( ).begin ( ), getAlphabet ( ).end ( ), ext::callback_iterator ( [ ] ( const common::ranked_symbol < SymbolType > & ) {
            throw TreeException ( "Input symbols not in the alphabet." );
        } ) );
 
    this->m_Data = std::move ( data );
}
 
template < class SymbolType >
void PrefixRankedBarTree < SymbolType >::arityChecksum ( const ext::vector < common::ranked_symbol < SymbolType > > & data ) {
    struct Data {
        int terminals;
        int bars;
        int types;
    };
 
    Data accRes = std::accumulate ( data.begin ( ), data.end ( ), Data { 1, 1, 0 }, [ * this ] ( const Data & current, const common::ranked_symbol < SymbolType > & symbol ) {
            if ( getBars ( ).contains ( symbol ) )
                return Data { current.terminals, static_cast < int > ( current.bars + symbol.getRank ( ) - 1 ), current.types - 1 };
            else
                return Data { static_cast < int > ( current.terminals + symbol.getRank ( ) - 1 ), current.bars, current.types + 1 };
        } );
 
    if ( accRes.terminals != 0 || accRes.bars != 0 || accRes.types != 0 )
        throw TreeException ( "The string does not form a tree" );
}
 
template < class SymbolType >
bool PrefixRankedBarTree < SymbolType >::isEmpty ( ) const {
    return this->m_Data.empty ( );
}
 
} /* namespace tree */
 
namespace core {
 
template < class SymbolType >
class SetConstraint< tree::PrefixRankedBarTree < SymbolType >, common::ranked_symbol < SymbolType >, tree::GeneralAlphabet > {
public:
    static bool used ( const tree::PrefixRankedBarTree < SymbolType > & tree, const common::ranked_symbol < SymbolType > & symbol ) {
        const ext::vector < common::ranked_symbol < SymbolType > > & content = tree.getContent ( );
 
        return std::find ( content.begin ( ), content.end ( ), symbol ) != content.end ( );
    }
 
    static bool available ( const tree::PrefixRankedBarTree < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
        return true;
    }
 
    static void valid ( const tree::PrefixRankedBarTree < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
    }
};
 
template < class SymbolType >
class SetConstraint< tree::PrefixRankedBarTree < SymbolType >, common::ranked_symbol < SymbolType >, tree::BarSymbols > {
public:
    static bool used ( const tree::PrefixRankedBarTree < SymbolType > & tree, const common::ranked_symbol < SymbolType > & symbol ) {
        const ext::vector < common::ranked_symbol < SymbolType > > & content = tree.getContent ( );
 
        return std::find ( content.begin ( ), content.end ( ), symbol ) != content.end ( );
    }
 
    static bool available ( const tree::PrefixRankedBarTree < SymbolType > & tree, const common::ranked_symbol < SymbolType > & symbol ) {
        return tree.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static void valid ( const tree::PrefixRankedBarTree < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
    }
};
 
template < class SymbolType >
struct normalize < tree::PrefixRankedBarTree < SymbolType > > {
    static tree::PrefixRankedBarTree < > eval ( tree::PrefixRankedBarTree < SymbolType > && value ) {
        ext::set < common::ranked_symbol < DefaultSymbolType > > bars = alphabet::SymbolNormalize::normalizeRankedAlphabet ( std::move ( value ).getBars ( ) );
        ext::set < common::ranked_symbol < DefaultSymbolType > > alphabet = alphabet::SymbolNormalize::normalizeRankedAlphabet ( std::move ( value ).getAlphabet ( ) );
        ext::vector < common::ranked_symbol < DefaultSymbolType > > content = alphabet::SymbolNormalize::normalizeRankedSymbols ( std::move ( value ).getContent ( ) );
 
        return tree::PrefixRankedBarTree < > ( std::move ( bars ), std::move ( alphabet ), std::move ( content ) );
    }
};
 
} /* namespace core */
 
extern template class tree::PrefixRankedBarTree < >;