PrefixRankedExtendedPattern.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 PrefixRankedExtendedPattern;
 
} /* 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/WildcardSymbol.h>
#include <alphabet/NodeWildcardSymbol.h>
 
#include <core/normalize.hpp>
#include <tree/common/TreeNormalize.h>
 
#include <string/LinearString.h>
 
#include "RankedExtendedPattern.h"
#include "PrefixRankedPattern.h"
 
namespace tree {
 
class GeneralAlphabet;
class SubtreeWildcard;
class NodeWildcard;
 
template < class SymbolType >
class PrefixRankedExtendedPattern final : public core::Components < PrefixRankedExtendedPattern < SymbolType >, ext::set < common::ranked_symbol < SymbolType > >, component::Set, std::tuple < GeneralAlphabet, NodeWildcards >, common::ranked_symbol < SymbolType >, component::Value, SubtreeWildcard > {
    ext::vector < common::ranked_symbol < SymbolType > > m_Data;
 
    void arityChecksum ( const ext::vector < common::ranked_symbol < SymbolType > > & data );
 
public:
    explicit PrefixRankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::set < common::ranked_symbol < SymbolType > > alphabet, ext::vector < common::ranked_symbol < SymbolType > > data );
 
    explicit PrefixRankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::vector < common::ranked_symbol < SymbolType > > data );
 
    explicit PrefixRankedExtendedPattern ( const PrefixRankedPattern < SymbolType > & pattern );
 
    explicit PrefixRankedExtendedPattern ( const RankedExtendedPattern < SymbolType > & pattern );
 
    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 > > & getNodeWildcards ( ) const & {
        return this->template accessComponent < NodeWildcards > ( ).get ( );
    }
 
    ext::set < common::ranked_symbol < SymbolType > > && getNodeWildcards ( ) && {
        return std::move ( this->template accessComponent < NodeWildcards > ( ).get ( ) );
    }
 
    void extendNodeWildcards ( const ext::set < common::ranked_symbol < SymbolType > > & symbols ) {
        this->template accessComponent < NodeWildcards > ( ).add ( symbols );
    }
 
    const common::ranked_symbol < SymbolType > & getSubtreeWildcard ( ) const & {
        return this->template accessComponent < SubtreeWildcard > ( ).get ( );
    }
 
    common::ranked_symbol < SymbolType > && getSubtreeWildcard ( ) && {
        return std::move ( this->template accessComponent < SubtreeWildcard > ( ).get ( ) );
    }
 
    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 PrefixRankedExtendedPattern & other ) const {
        return std::tie ( m_Data, getAlphabet ( ), getSubtreeWildcard ( ), getNodeWildcards ( ) ) <=> std::tie ( other.m_Data, other.getAlphabet ( ), other.getSubtreeWildcard ( ), other.getNodeWildcards ( ) );
    }
 
    bool operator == ( const PrefixRankedExtendedPattern & other ) const {
        return std::tie ( m_Data, getAlphabet ( ), getSubtreeWildcard ( ), getNodeWildcards ( ) ) == std::tie ( other.m_Data, other.getAlphabet ( ), other.getSubtreeWildcard ( ), other.getNodeWildcards ( ) );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const PrefixRankedExtendedPattern & instance ) {
        out << "(PrefixRankedExtendedPattern ";
        out << "alphabet = " << instance.getAlphabet ( );
        out << "content = " << instance.getContent ( );
        out << "subtreeWildcard = " << instance.getSubtreeWildcard ( );
        out << "nodeWildcards = " << instance.getNodeWildcards ( );
        out << ")";
        return out;
    }
 
    explicit operator string::LinearString < common::ranked_symbol < SymbolType > > ( ) const {
        return string::LinearString < common::ranked_symbol < SymbolType > > ( getAlphabet ( ), getContent ( ) );
    }
};
 
template < class SymbolType >
PrefixRankedExtendedPattern < SymbolType >::PrefixRankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::set < common::ranked_symbol < SymbolType > > alphabet, ext::vector < common::ranked_symbol < SymbolType > > data ) : core::Components < PrefixRankedExtendedPattern, ext::set < common::ranked_symbol < SymbolType > >, component::Set, std::tuple < GeneralAlphabet, NodeWildcards >, common::ranked_symbol < SymbolType >, component::Value, SubtreeWildcard > ( std::move ( alphabet ), std::move ( nodeWildcards ), std::move ( subtreeWildcard ) ) {
    setContent ( std::move ( data ) );
}
 
template < class SymbolType >
PrefixRankedExtendedPattern < SymbolType >::PrefixRankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::vector < common::ranked_symbol < SymbolType > > data ) : PrefixRankedExtendedPattern ( subtreeWildcard, nodeWildcards, ext::set < common::ranked_symbol < SymbolType > > ( data.begin ( ), data.end ( ) ) + ext::set < common::ranked_symbol < SymbolType > > { subtreeWildcard } + nodeWildcards, data ) {
}
 
template < class SymbolType >
PrefixRankedExtendedPattern < SymbolType >::PrefixRankedExtendedPattern ( const PrefixRankedPattern < SymbolType > & pattern ) : PrefixRankedExtendedPattern ( pattern.getSubtreeWildcard ( ), { }, pattern.getAlphabet ( ) + ext::set < common::ranked_symbol < SymbolType > > { pattern.getSubtreeWildcard ( ) }, pattern.getContent ( ) ) {
}
 
template < class SymbolType >
PrefixRankedExtendedPattern < SymbolType >::PrefixRankedExtendedPattern ( const RankedExtendedPattern < SymbolType > & pattern ) : PrefixRankedExtendedPattern ( pattern.getSubtreeWildcard ( ), pattern.getNodeWildcards ( ), pattern.getAlphabet ( ), TreeAuxiliary::treeToPrefix ( pattern.getContent ( ) ) ) {
}
 
template < class SymbolType >
const ext::vector < common::ranked_symbol < SymbolType > > & PrefixRankedExtendedPattern < SymbolType >::getContent ( ) const & {
    return this->m_Data;
}
 
template < class SymbolType >
ext::vector < common::ranked_symbol < SymbolType > > && PrefixRankedExtendedPattern < SymbolType >::getContent ( ) && {
    return std::move ( this->m_Data );
}
 
template < class SymbolType >
void PrefixRankedExtendedPattern < 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 PrefixRankedExtendedPattern < SymbolType >::arityChecksum ( const ext::vector < common::ranked_symbol < SymbolType > > & data ) {
    if ( std::accumulate ( data.begin ( ), data.end ( ), 1, [ ] ( int current, const common::ranked_symbol < SymbolType > & symbol ) {
                return current + symbol.getRank ( ) - 1;
            } ) != 0 )
        throw TreeException ( "The string does not form a tree" );
}
 
template < class SymbolType >
bool PrefixRankedExtendedPattern < SymbolType >::isEmpty ( ) const {
    return this->m_Data.empty ( );
}
 
} /* namespace tree */
 
namespace core {
 
template < class SymbolType >
class SetConstraint< tree::PrefixRankedExtendedPattern < SymbolType >, common::ranked_symbol < SymbolType >, tree::GeneralAlphabet > {
public:
    static bool used ( const tree::PrefixRankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        const ext::vector < common::ranked_symbol < SymbolType > > & content = pattern.getContent ( );
 
        return std::find ( content.begin ( ), content.end ( ), symbol ) != content.end ( ) || pattern.template accessComponent < tree::SubtreeWildcard > ( ).get ( ) == symbol || pattern.template accessComponent < tree::NodeWildcards > ( ).get ( ).contains ( symbol );
    }
 
    static bool available ( const tree::PrefixRankedExtendedPattern < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
        return true;
    }
 
    static void valid ( const tree::PrefixRankedExtendedPattern < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
    }
};
 
template < class SymbolType >
class SetConstraint< tree::PrefixRankedExtendedPattern < SymbolType >, common::ranked_symbol < SymbolType >, tree::NodeWildcards > {
public:
    static bool used ( const tree::PrefixRankedExtendedPattern < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
        return false;
    }
 
    static bool available ( const tree::PrefixRankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).contains ( symbol );
    }
 
    static void valid ( const tree::PrefixRankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        if ( pattern.template accessComponent < tree::SubtreeWildcard > ( ).get ( ) == symbol )
            throw tree::TreeException ( "NodeWildcard is already a SubtreeWildcard" );
    }
};
 
template < class SymbolType >
class ElementConstraint< tree::PrefixRankedExtendedPattern < SymbolType >, common::ranked_symbol < SymbolType >, tree::SubtreeWildcard > {
public:
    static bool available ( const tree::PrefixRankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).contains ( symbol );
    }
 
    static void valid ( const tree::PrefixRankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol) {
        if( symbol.getRank() != 0 )
            throw tree::TreeException ( "SubtreeWildcard symbol has nonzero arity" );
        if ( pattern.template accessComponent < tree::NodeWildcards > ( ).get ( ).contains ( symbol ) )
            throw tree::TreeException ( "SubtreeWildcard is already a NodeWildcard" );
    }
};
 
template < class SymbolType >
struct normalize < tree::PrefixRankedExtendedPattern < SymbolType > > {
    static tree::PrefixRankedExtendedPattern < > eval ( tree::PrefixRankedExtendedPattern < SymbolType > && value ) {
        common::ranked_symbol < DefaultSymbolType > wildcard = alphabet::SymbolNormalize::normalizeRankedSymbol ( std::move ( value ).getSubtreeWildcard ( ) );
        ext::set < common::ranked_symbol < DefaultSymbolType > > nodeWildcards = alphabet::SymbolNormalize::normalizeRankedAlphabet ( std::move ( value ).getNodeWildcards ( ) );
        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::PrefixRankedExtendedPattern < > ( std::move ( wildcard ), std::move ( nodeWildcards ), std::move ( alphabet ), std::move ( content ) );
    }
};
 
} /* namespace core */
 
extern template class tree::PrefixRankedExtendedPattern < >;