RankedExtendedPattern.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 RankedExtendedPattern;
 
} /* namespace tree */
 
 
#include <ext/algorithm>
#include <ext/iostream>
 
#include <alib/string>
#include <alib/set>
#include <alib/tree>
 
#include <core/components.hpp>
#include <common/ranked_symbol.hpp>
 
#include <tree/TreeException.h>
#include <tree/common/TreeAuxiliary.h>
 
#include <core/normalize.hpp>
#include <tree/common/TreeNormalize.h>
 
#include "RankedPattern.h"
 
namespace tree {
 
class GeneralAlphabet;
class NodeWildcards;
class SubtreeWildcard;
 
template < class SymbolType >
class RankedExtendedPattern final : public core::Components < RankedExtendedPattern < SymbolType >, ext::set < common::ranked_symbol < SymbolType > >, component::Set, std::tuple < GeneralAlphabet, NodeWildcards >, common::ranked_symbol < SymbolType >, component::Value, SubtreeWildcard > {
    ext::tree < common::ranked_symbol < SymbolType > > m_content;
 
    void checkAlphabet ( const ext::tree < common::ranked_symbol < SymbolType > > & data ) const;
 
    void checkArities ( const ext::tree < common::ranked_symbol < SymbolType > > & data ) const;
 
public:
    explicit RankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::set < common::ranked_symbol < SymbolType > > alphabet, ext::tree < common::ranked_symbol < SymbolType > > pattern );
 
    explicit RankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::tree < common::ranked_symbol < SymbolType > > pattern );
 
    explicit RankedExtendedPattern ( const RankedPattern < SymbolType > & other );
 
    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::tree < common::ranked_symbol < SymbolType > > & getContent ( ) const &;
 
    ext::tree < common::ranked_symbol < SymbolType > > && getContent ( ) &&;
 
    void setTree ( ext::tree < common::ranked_symbol < SymbolType > > pattern );
 
    auto operator <=> ( const RankedExtendedPattern & other ) const {
        return std::tie ( m_content, getAlphabet(), getSubtreeWildcard(), getNodeWildcards ( ) ) <=> std::tie ( other.m_content, other.getAlphabet(), other.getSubtreeWildcard(), other.getNodeWildcards ( ) );
    }
 
    bool operator == ( const RankedExtendedPattern & other ) const {
        return std::tie ( m_content, getAlphabet(), getSubtreeWildcard(), getNodeWildcards ( ) ) == std::tie ( other.m_content, other.getAlphabet(), other.getSubtreeWildcard(), other.getNodeWildcards ( ) );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const RankedExtendedPattern & instance ) {
        out << "(RankedExtendedPattern ";
        out << "alphabet = " << instance.getAlphabet ( );
        out << "content = " << instance.getContent ( );
        out << "subtreeWildcard = " << instance.getSubtreeWildcard ( );
        out << "nodeWildcards = " << instance.getNodeWildcards ( );
        out << ")";
        return out;
    }
 
    void nicePrint ( ext::ostream & os ) const;
};
 
template < class SymbolType >
RankedExtendedPattern < SymbolType >::RankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::set < common::ranked_symbol < SymbolType > > alphabet, ext::tree < common::ranked_symbol < SymbolType > > pattern ) : core::Components < RankedExtendedPattern, 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 ) ), m_content ( std::move ( pattern ) ) {
    checkAlphabet ( m_content );
    checkArities ( m_content );
}
 
template < class SymbolType >
RankedExtendedPattern < SymbolType >::RankedExtendedPattern ( common::ranked_symbol < SymbolType > subtreeWildcard, ext::set < common::ranked_symbol < SymbolType > > nodeWildcards, ext::tree < common::ranked_symbol < SymbolType > > pattern ) : RankedExtendedPattern ( subtreeWildcard, nodeWildcards, ext::set < common::ranked_symbol < SymbolType > > ( pattern.prefix_begin ( ), pattern.prefix_end ( ) ) + ext::set < common::ranked_symbol < SymbolType > > { subtreeWildcard } + nodeWildcards, pattern ) {
}
 
template < class SymbolType >
RankedExtendedPattern < SymbolType >::RankedExtendedPattern ( const RankedPattern < SymbolType > & other ) : RankedExtendedPattern ( other.getSubtreeWildcard ( ), ext::set < common::ranked_symbol < SymbolType > > { }, other.getAlphabet ( ), other.getContent ( ) ) {
}
 
template < class SymbolType >
const ext::tree < common::ranked_symbol < SymbolType > > & RankedExtendedPattern < SymbolType >::getContent ( ) const & {
    return m_content;
}
 
template < class SymbolType >
ext::tree < common::ranked_symbol < SymbolType > > && RankedExtendedPattern < SymbolType >::getContent ( ) && {
    return std::move ( m_content );
}
 
template < class SymbolType >
void RankedExtendedPattern < SymbolType >::checkAlphabet ( const ext::tree < common::ranked_symbol < SymbolType > > & data ) const {
    ext::set < common::ranked_symbol < SymbolType > > minimalAlphabet ( data.prefix_begin ( ), data.prefix_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." );
        } ) );
}
 
template < class SymbolType >
void RankedExtendedPattern < SymbolType >::checkArities ( const ext::tree < common::ranked_symbol < SymbolType > > & data ) const {
    if ( data.getData ( ).getRank ( ) != data.getChildren ( ).size ( ) )
        throw exception::CommonException ( "Invalid rank." );
 
    for ( const ext::tree < common::ranked_symbol < SymbolType > > & child : data )
        checkArities ( child );
}
 
template < class SymbolType >
void RankedExtendedPattern < SymbolType >::setTree ( ext::tree < common::ranked_symbol < SymbolType > > pattern ) {
    checkAlphabet ( pattern );
    checkArities ( pattern );
 
    this->m_content = std::move ( pattern );
}
 
template < class SymbolType >
void RankedExtendedPattern < SymbolType >::nicePrint ( ext::ostream & os ) const {
    m_content.nicePrint ( os );
}
 
} /* namespace tree */
 
namespace core {
 
template < class SymbolType >
class SetConstraint< tree::RankedExtendedPattern < SymbolType >, common::ranked_symbol < SymbolType >, tree::GeneralAlphabet > {
public:
    static bool used ( const tree::RankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        const ext::tree < common::ranked_symbol < SymbolType > > & m_content = pattern.getContent ( );
        return std::find(m_content.prefix_begin(), m_content.prefix_end(), symbol) != m_content.prefix_end() || pattern.template accessComponent < tree::SubtreeWildcard > ( ).get ( ) == symbol || pattern.template accessComponent < tree::NodeWildcards > ( ).get ( ).contains ( symbol );
    }
 
    static bool available ( const tree::RankedExtendedPattern < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
        return true;
    }
 
    static void valid ( const tree::RankedExtendedPattern < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
    }
};
 
template < class SymbolType >
class SetConstraint< tree::RankedExtendedPattern < SymbolType >, common::ranked_symbol < SymbolType >, tree::NodeWildcards > {
public:
    static bool used ( const tree::RankedExtendedPattern < SymbolType > &, const common::ranked_symbol < SymbolType > & ) {
        return false;
    }
 
    static bool available ( const tree::RankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).contains ( symbol );
    }
 
    static void valid ( const tree::RankedExtendedPattern < 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::RankedExtendedPattern < SymbolType >, common::ranked_symbol < SymbolType >, tree::SubtreeWildcard > {
public:
    static bool available ( const tree::RankedExtendedPattern < SymbolType > & pattern, const common::ranked_symbol < SymbolType > & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static void valid ( const tree::RankedExtendedPattern < 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::RankedExtendedPattern < SymbolType > > {
    static tree::RankedExtendedPattern < > eval ( tree::RankedExtendedPattern < SymbolType > && value ) {
        common::ranked_symbol < DefaultSymbolType > wildcard = alphabet::SymbolNormalize::normalizeRankedSymbol ( std::move ( value ).getSubtreeWildcard ( ) );
        ext::set < common::ranked_symbol < DefaultSymbolType > > alphabet = alphabet::SymbolNormalize::normalizeRankedAlphabet ( std::move ( value ).getAlphabet ( ) );
        ext::set < common::ranked_symbol < DefaultSymbolType > > nodeWildcards = alphabet::SymbolNormalize::normalizeRankedAlphabet ( std::move ( value ).getNodeWildcards ( ) );
        ext::tree < common::ranked_symbol < DefaultSymbolType > > content = tree::TreeNormalize::normalizeRankedTree ( std::move ( value ).getContent ( ) );
 
        return tree::RankedExtendedPattern < > ( std::move ( wildcard ), std::move ( nodeWildcards ), std::move ( alphabet ), std::move ( content ) );
    }
};
 
} /* namespace core */
 
extern template class tree::RankedExtendedPattern < >;