PrefixBarTree.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 PrefixBarTree;
 
} /* namespace tree */
 
 
#include <ext/algorithm>
 
#include <alib/deque>
#include <alib/set>
#include <alib/vector>
#include <alib/tree>
 
#include <core/components.hpp>
 
#include <alphabet/BarSymbol.h>
 
#include <tree/TreeException.h>
#include <tree/common/TreeAuxiliary.h>
 
#include <core/normalize.hpp>
#include <tree/common/TreeNormalize.h>
 
#include "UnrankedTree.h"
 
#include <string/LinearString.h>
 
namespace tree {
 
class GeneralAlphabet;
class BarSymbol;
 
template < class SymbolType >
class PrefixBarTree final : public core::Components < PrefixBarTree < SymbolType >, ext::set < SymbolType >, component::Set, GeneralAlphabet, SymbolType, component::Value, BarSymbol > {
    ext::vector < SymbolType > m_Data;
 
    void arityChecksum ( const ext::vector < SymbolType > & data );
 
public:
    explicit PrefixBarTree ( SymbolType bar, ext::set < SymbolType > alphabet, ext::vector < SymbolType > data );
 
    explicit PrefixBarTree ( SymbolType bar, ext::vector < SymbolType > data );
 
    explicit PrefixBarTree ( SymbolType bar, const UnrankedTree < SymbolType > & tree );
 
    explicit PrefixBarTree ( const UnrankedTree < SymbolType > & tree );
 
    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 extendAlphabet ( const ext::set < SymbolType > & symbols ) {
        this->template accessComponent < GeneralAlphabet > ( ).add ( symbols );
    }
 
    const SymbolType & getBar ( ) const & {
        return this->template accessComponent < BarSymbol > ( ).get ( );
    }
 
    SymbolType && getBar ( ) && {
        return std::move ( this->template accessComponent < BarSymbol > ( ).get ( ) );
    }
 
    const ext::vector < SymbolType > & getContent ( ) const &;
 
    ext::vector < SymbolType > && getContent ( ) &&;
 
    void setContent ( ext::vector < SymbolType > data );
 
    bool isEmpty ( ) const;
 
    auto operator <=> ( const PrefixBarTree & other ) const {
        return std::tie ( m_Data, getAlphabet ( ), getBar ( ) ) <=> std::tie ( other.m_Data, other.getAlphabet ( ), other.getBar ( ) );
    }
 
    bool operator == ( const PrefixBarTree & other ) const {
        return std::tie ( m_Data, getAlphabet ( ), getBar ( ) ) == std::tie ( other.m_Data, other.getAlphabet ( ), other.getBar ( ) );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const PrefixBarTree & instance ) {
        out << "(PrefixBarTree";
        out << " alphabet = " << instance.getAlphabet ( );
        out << " content = " << instance.getContent ( );
        out << ")";
        return out;
    }
 
    explicit operator string::LinearString < SymbolType > ( ) const {
        return string::LinearString < SymbolType > ( getAlphabet ( ), getContent ( ) );
    }
};
 
template < class SymbolType >
PrefixBarTree < SymbolType >::PrefixBarTree ( SymbolType bar, ext::set < SymbolType > alphabet, ext::vector < SymbolType > data ) : core::Components < PrefixBarTree, ext::set < SymbolType >, component::Set, GeneralAlphabet, SymbolType, component::Value, BarSymbol > ( std::move ( alphabet ), std::move ( bar ) ) {
    setContent ( std::move ( data ) );
}
 
template < class SymbolType >
PrefixBarTree < SymbolType >::PrefixBarTree ( SymbolType bar, ext::vector < SymbolType > data ) : PrefixBarTree ( bar, ext::set < SymbolType > ( data.begin ( ), data.end ( ) ) + ext::set < SymbolType > { bar }, data ) {
}
 
template < class SymbolType >
PrefixBarTree < SymbolType >::PrefixBarTree ( SymbolType bar, const UnrankedTree < SymbolType > & tree ) : PrefixBarTree ( bar, tree.getAlphabet ( ) + ext::set < SymbolType > { bar }, TreeAuxiliary::treeToPrefix ( tree.getContent ( ), bar ) ) {
}
 
template < class SymbolType >
PrefixBarTree < SymbolType >::PrefixBarTree ( const UnrankedTree < SymbolType > & tree ) : PrefixBarTree ( alphabet::BarSymbol::instance < SymbolType > ( ), tree ) {
}
 
template < class SymbolType >
const ext::vector < SymbolType > & PrefixBarTree < SymbolType >::getContent ( ) const & {
    return this->m_Data;
}
 
template < class SymbolType >
ext::vector < SymbolType > && PrefixBarTree < SymbolType >::getContent ( ) && {
    return std::move ( this->m_Data );
}
 
template < class SymbolType >
void PrefixBarTree < SymbolType >::setContent ( ext::vector < SymbolType > data ) {
    arityChecksum ( data );
 
    ext::set < SymbolType > minimalAlphabet ( data.begin ( ), data.end ( ) );
    std::set_difference ( minimalAlphabet.begin ( ), minimalAlphabet.end ( ), getAlphabet ( ).begin ( ), getAlphabet ( ).end ( ), ext::callback_iterator ( [ ] ( const SymbolType & ) {
            throw TreeException ( "Input symbols not in the alphabet." );
        } ) );
 
    this->m_Data = std::move ( data );
}
 
template < class SymbolType >
void PrefixBarTree < SymbolType >::arityChecksum ( const ext::vector < SymbolType > & data ) {
    int arityChecksumTypes = 0;
 
    for ( const SymbolType & symbol : data ) {
        if ( symbol == getBar ( ) )
            arityChecksumTypes -= 1;
        else
            arityChecksumTypes += 1;
    }
 
    if ( arityChecksumTypes != 0 ) throw TreeException ( "The string does not form a tree" );
}
 
template < class SymbolType >
bool PrefixBarTree < SymbolType >::isEmpty ( ) const {
    return this->m_Data.empty ( );
}
 
} /* namespace tree */
 
namespace core {
 
template < class SymbolType >
class SetConstraint< tree::PrefixBarTree < SymbolType >, SymbolType, tree::GeneralAlphabet > {
public:
    static bool used ( const tree::PrefixBarTree < SymbolType > & tree, const SymbolType & symbol ) {
        const ext::vector < SymbolType > & content = tree.getContent ( );
 
        return std::find ( content.begin ( ), content.end ( ), symbol ) != content.end ( );
    }
 
    static bool available ( const tree::PrefixBarTree < SymbolType > &, const SymbolType & ) {
        return true;
    }
 
    static void valid ( const tree::PrefixBarTree < SymbolType > &, const SymbolType & ) {
    }
};
 
template < class SymbolType >
class ElementConstraint< tree::PrefixBarTree < SymbolType >, SymbolType, tree::BarSymbol > {
public:
    static bool available ( const tree::PrefixBarTree < SymbolType > & tree, const SymbolType & symbol ) {
        return tree.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static void valid ( const tree::PrefixBarTree < SymbolType > &, const SymbolType & ) {
    }
};
 
template < class SymbolType >
struct normalize < tree::PrefixBarTree < SymbolType > > {
    static tree::PrefixBarTree < > eval ( tree::PrefixBarTree < SymbolType > && value ) {
        DefaultSymbolType bar = alphabet::SymbolNormalize::normalizeSymbol ( std::move ( value ).getBar ( ) );
        ext::set < DefaultSymbolType > alphabet = alphabet::SymbolNormalize::normalizeAlphabet ( std::move ( value ).getAlphabet ( ) );
        ext::vector < DefaultSymbolType > content = alphabet::SymbolNormalize::normalizeSymbols ( std::move ( value ).getContent ( ) );
 
        return tree::PrefixBarTree < > ( std::move ( bar ), std::move ( alphabet ), std::move ( content ) );
    }
};
 
} /* namespace core */
 
extern template class tree::PrefixBarTree < >;