UnrankedNonlinearPattern.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 UnrankedNonlinearPattern;
 
} /* namespace tree */
 
 
#include <ext/iostream>
#include <ext/algorithm>
 
#include <alib/string>
#include <alib/set>
#include <alib/tree>
 
#include <core/components.hpp>
 
#include <tree/TreeException.h>
#include <tree/common/TreeAuxiliary.h>
 
#include <core/normalize.hpp>
#include <tree/common/TreeNormalize.h>
 
#include <tree/ranked/RankedNonlinearPattern.h>
#include <alphabet/GapSymbol.h>
 
namespace tree {
 
class GeneralAlphabet;
class SubtreeWildcard;
class SubtreeGap;
class NonlinearAlphabet;
 
template < class SymbolType >
class UnrankedNonlinearPattern final : public core::Components < UnrankedNonlinearPattern < SymbolType >, ext::set < SymbolType >, component::Set, std::tuple < GeneralAlphabet, NonlinearAlphabet >, SymbolType, component::Value, std::tuple < SubtreeWildcard, SubtreeGap > > {
    ext::tree < SymbolType > m_content;
 
    void checkAlphabet ( const ext::tree < SymbolType > & data ) const;
 
public:
    explicit UnrankedNonlinearPattern ( SymbolType subtreeWildcard, SymbolType subtreeGap, ext::set < SymbolType > nonlinearVariables, ext::set < SymbolType > alphabet, ext::tree < SymbolType > pattern );
 
    explicit UnrankedNonlinearPattern ( SymbolType subtreeWildcard, SymbolType subtreeGap, ext::set < SymbolType > nonlinearVariables, ext::tree < SymbolType > pattern );
 
    explicit UnrankedNonlinearPattern ( SymbolType subtreeWildcard, SymbolType subtreeGap, ext::tree < SymbolType > pattern );
 
    explicit UnrankedNonlinearPattern ( const RankedNonlinearPattern < SymbolType > & other );
 
    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 & getSubtreeWildcard ( ) const & {
        return this->template accessComponent < SubtreeWildcard > ( ).get ( );
    }
 
    SymbolType && getSubtreeWildcard ( ) && {
        return std::move ( this->template accessComponent < SubtreeWildcard > ( ).get ( ) );
    }
 
    const SymbolType & getSubtreeGap ( ) const & {
        return this->template accessComponent < SubtreeGap > ( ).get ( );
    }
 
    SymbolType && getSubtreeGap ( ) && {
        return std::move ( this->template accessComponent < SubtreeGap > ( ).get ( ) );
    }
 
    const ext::set < SymbolType > & getNonlinearVariables ( ) const & {
        return this->template accessComponent < NonlinearAlphabet > ( ).get ( );
    }
 
    ext::set < SymbolType > && getNonlinearVariables ( ) && {
        return std::move ( this->template accessComponent < NonlinearAlphabet > ( ).get ( ) );
    }
 
    const ext::tree < SymbolType > & getContent ( ) const &;
 
    ext::tree < SymbolType > && getContent ( ) &&;
 
    void setTree ( ext::tree < SymbolType > pattern );
 
    auto operator <=> ( const UnrankedNonlinearPattern & other ) const {
        return std::tie ( m_content, getAlphabet(), getSubtreeWildcard(), getNonlinearVariables() ) <=> std::tie ( other.m_content, other.getAlphabet(), other.getSubtreeWildcard(), getNonlinearVariables() );
    }
 
    bool operator == ( const UnrankedNonlinearPattern & other ) const {
        return std::tie ( m_content, getAlphabet(), getSubtreeWildcard(), getNonlinearVariables() ) == std::tie ( other.m_content, other.getAlphabet(), other.getSubtreeWildcard(), getNonlinearVariables() );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const UnrankedNonlinearPattern & instance ) {
        out << "(UnrankedNonlinearPattern ";
        out << " alphabet = " << instance.getAlphabet ( );
        out << " content = " << instance.getContent ( );
        out << " nonlinearVariables = " << instance.getNonlinearVariables ( );
        out << " subtreeWildcard = " << instance.getSubtreeWildcard ( );
        out << " subtreeGap = " << instance.getSubtreeGap ( );
        out << ")";
        return out;
    }
 
    void nicePrint ( ext::ostream & out ) const;
};
 
template < class SymbolType >
UnrankedNonlinearPattern < SymbolType >::UnrankedNonlinearPattern ( SymbolType subtreeWildcard, SymbolType subtreeGap, ext::set < SymbolType > nonlinearVariables, ext::set < SymbolType > alphabet, ext::tree < SymbolType > pattern ) : core::Components < UnrankedNonlinearPattern, ext::set < SymbolType >, component::Set, std::tuple < GeneralAlphabet, NonlinearAlphabet >, SymbolType, component::Value, std::tuple < SubtreeWildcard, SubtreeGap > > ( std::move ( alphabet ), std::move ( nonlinearVariables ), std::move ( subtreeWildcard ), std::move ( subtreeGap ) ), m_content ( std::move ( pattern ) ) {
    checkAlphabet ( m_content );
}
 
template < class SymbolType >
UnrankedNonlinearPattern < SymbolType >::UnrankedNonlinearPattern ( SymbolType subtreeWildcard, SymbolType subtreeGap, ext::set < SymbolType > nonlinearVariables, ext::tree < SymbolType > pattern ) : UnrankedNonlinearPattern ( subtreeWildcard, subtreeGap, nonlinearVariables, ext::set < SymbolType > ( pattern.prefix_begin ( ), pattern.prefix_end ( ) ) + nonlinearVariables + ext::set < SymbolType > { subtreeWildcard, subtreeGap }, pattern ) {
}
 
template < class SymbolType >
UnrankedNonlinearPattern < SymbolType >::UnrankedNonlinearPattern ( SymbolType subtreeWildcard, SymbolType subtreeGap, ext::tree < SymbolType > pattern ) : UnrankedNonlinearPattern ( subtreeWildcard, subtreeGap, ext::set < SymbolType > { }, pattern ) {
}
 
template < class SymbolType >
UnrankedNonlinearPattern < SymbolType >::UnrankedNonlinearPattern ( const RankedNonlinearPattern < SymbolType > & other ) : UnrankedNonlinearPattern ( other.getSubtreeWildcard ( ).getSymbol ( ), alphabet::GapSymbol::instance < SymbolType > ( ), TreeAuxiliary::unrankSymbols ( other.getAlphabet ( ) ) + ext::set < SymbolType > { alphabet::GapSymbol::instance < SymbolType > ( ) }, TreeAuxiliary::rankedToUnranked ( other.getContent ( ) ) ) {
}
 
template < class SymbolType >
const ext::tree < SymbolType > & UnrankedNonlinearPattern < SymbolType >::getContent ( ) const & {
    return m_content;
}
 
template < class SymbolType >
ext::tree < SymbolType > && UnrankedNonlinearPattern < SymbolType >::getContent ( ) && {
    return std::move ( m_content );
}
 
template < class SymbolType >
void UnrankedNonlinearPattern < SymbolType >::checkAlphabet ( const ext::tree < SymbolType > & data ) const {
    ext::set < SymbolType > minimalAlphabet ( data.prefix_begin ( ), data.prefix_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." );
        } ) );
}
 
template < class SymbolType >
void UnrankedNonlinearPattern < SymbolType >::setTree ( ext::tree < SymbolType > pattern ) {
    checkAlphabet ( pattern );
 
    this->m_content = std::move ( pattern );
}
 
template < class SymbolType >
void UnrankedNonlinearPattern < SymbolType >::nicePrint ( ext::ostream & out ) const {
    m_content.nicePrint ( out );
}
 
} /* namespace tree */
 
namespace core {
 
template < class SymbolType >
class SetConstraint< tree::UnrankedNonlinearPattern < SymbolType >, SymbolType, tree::GeneralAlphabet > {
public:
    static bool used ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol ) {
        const ext::tree<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::NonlinearAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static bool available ( const tree::UnrankedNonlinearPattern < SymbolType > &, const SymbolType & ) {
        return true;
    }
 
    static void valid ( const tree::UnrankedNonlinearPattern < SymbolType > &, const SymbolType & ) {
    }
};
 
template < class SymbolType >
class SetConstraint< tree::UnrankedNonlinearPattern < SymbolType >, SymbolType, tree::NonlinearAlphabet > {
public:
    static bool used ( const tree::UnrankedNonlinearPattern < SymbolType > &, const SymbolType & ) {
        return false;
    }
 
    static bool available ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static void valid ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol) {
        if ( pattern.template accessComponent < tree::SubtreeWildcard > ( ).get ( ) == symbol )
            throw tree::TreeException ( "Symbol " + ext::to_string ( symbol ) + "cannot be set as nonlinear variable since it is already subtree wildcard" );
    }
};
 
template < class SymbolType >
class ElementConstraint< tree::UnrankedNonlinearPattern < SymbolType >, SymbolType, tree::SubtreeWildcard > {
public:
    static bool available ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static void valid ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol) {
        if ( pattern.template accessComponent < tree::NonlinearAlphabet > ( ).get ( ).count ( symbol ) )
            throw tree::TreeException ( "Symbol " + ext::to_string ( symbol ) + "cannot be set as subtree wildcard since it is already nonlinear variable" );
    }
};
 
template < class SymbolType >
class ElementConstraint< tree::UnrankedNonlinearPattern < SymbolType >, SymbolType, tree::SubtreeGap > {
public:
    static bool available ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol ) {
        return pattern.template accessComponent < tree::GeneralAlphabet > ( ).get ( ).count ( symbol );
    }
 
    static void valid ( const tree::UnrankedNonlinearPattern < SymbolType > & pattern, const SymbolType & symbol) {
        if ( pattern.template accessComponent < tree::NonlinearAlphabet > ( ).get ( ).count ( symbol ) )
            throw tree::TreeException ( "Symbol " + ext::to_string ( symbol ) + "cannot be set as subtree wildcard since it is already nonlinear variable" );
    }
};
 
template < class SymbolType >
struct normalize < tree::UnrankedNonlinearPattern < SymbolType > > {
    static tree::UnrankedNonlinearPattern < > eval ( tree::UnrankedNonlinearPattern < SymbolType > && value ) {
        DefaultSymbolType wildcard = alphabet::SymbolNormalize::normalizeSymbol ( std::move ( value ).getSubtreeWildcard ( ) );
        DefaultSymbolType gap = alphabet::SymbolNormalize::normalizeSymbol ( std::move ( value ).getSubtreeGap ( ) );
        ext::set < DefaultSymbolType > nonlinearAlphabet = alphabet::SymbolNormalize::normalizeAlphabet ( std::move ( value ).getNonlinearVariables ( ) );
        ext::set < DefaultSymbolType > alphabet = alphabet::SymbolNormalize::normalizeAlphabet ( std::move ( value ).getAlphabet ( ) );
        ext::tree < DefaultSymbolType > content = tree::TreeNormalize::normalizeTree ( std::move ( value ).getContent ( ) );
 
        return tree::UnrankedNonlinearPattern < > ( std::move ( wildcard ), std::move ( gap ), std::move ( nonlinearAlphabet ), std::move ( alphabet ), std::move ( content ) );
    }
};
 
} /* namespace core */
 
extern template class tree::UnrankedNonlinearPattern < >;