CyclicString.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 <ext/algorithm>
 
#include <alib/set>
#include <alib/vector>
 
#include <core/components.hpp>
 
#include <common/DefaultSymbolType.h>
 
#include <exception/CommonException.h>
 
#include <core/normalize.hpp>
#include <alphabet/common/SymbolNormalize.h>
 
namespace string {
 
class GeneralAlphabet;
 
template < class SymbolType = DefaultSymbolType >
class CyclicString final : public core::Components < CyclicString < SymbolType >, ext::set < SymbolType >, component::Set, GeneralAlphabet > {
    ext::vector < SymbolType > m_Data;
 
public:
    explicit CyclicString ( );
 
    explicit CyclicString ( ext::set < SymbolType > alphabet, ext::vector < SymbolType > str );
 
    explicit CyclicString ( ext::vector < SymbolType > str );
 
    explicit CyclicString ( const std::string & str );
 
    explicit CyclicString ( const char * str );
 
    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 ( ext::set < SymbolType > symbols ) {
        this->template accessComponent < GeneralAlphabet > ( ).add ( std::move ( symbols ) );
    }
 
    const ext::vector < SymbolType > & getContent ( ) const &;
 
    ext::vector < SymbolType > && getContent ( ) &&;
 
    void setContent ( ext::vector < SymbolType > str );
 
    bool isEmpty ( ) const;
 
    auto operator <=> ( const CyclicString & other ) const {
        return std::tie ( m_Data, getAlphabet ( ) ) <=> std::tie ( other.m_Data, other.getAlphabet ( ) );
    }
 
    bool operator == ( const CyclicString & other ) const {
        return std::tie ( m_Data, getAlphabet ( ) ) == std::tie ( other.m_Data, other.getAlphabet ( ) );
    }
 
    friend ext::ostream & operator << ( ext::ostream & out, const CyclicString & instance ) {
        out << "(CyclicString";
        out << " content = " << instance.getContent ( );
        out << " alphabet = " << instance.getAlphabet ( );
        out << ")";
        return out;
    }
};
 
template < class SymbolType >
CyclicString < SymbolType >::CyclicString(ext::set<SymbolType> alphabet, ext::vector<SymbolType> str) : core::Components < CyclicString, ext::set < SymbolType >, component::Set, GeneralAlphabet > ( std::move ( alphabet ) ) {
    setContent(std::move(str));
}
 
template < class SymbolType >
CyclicString < SymbolType >::CyclicString() : CyclicString ( ext::set < SymbolType > ( ), ext::vector < SymbolType > ( ) ) {
}
 
template < class SymbolType >
CyclicString < SymbolType >::CyclicString(ext::vector<SymbolType> str) : CyclicString ( ext::set < SymbolType> ( str.begin(), str.end() ), str ) {
}
 
template < class SymbolType >
CyclicString < SymbolType >::CyclicString(const std::string& str) : CyclicString ( ext::vector < SymbolType > ( str.begin ( ), str.end ( ) ) ) {
}
 
template < class SymbolType >
CyclicString < SymbolType >::CyclicString ( const char * str ) : CyclicString ( std::string ( str ) ) {
}
 
template < class SymbolType >
const ext::vector < SymbolType > & CyclicString < SymbolType >::getContent ( ) const & {
    return this->m_Data;
}
 
template < class SymbolType >
ext::vector < SymbolType > && CyclicString < SymbolType >::getContent ( ) && {
    return std::move ( this->m_Data );
}
 
//serves as both move and copy content setter
template < class SymbolType >
void CyclicString < SymbolType >::setContent(ext::vector<SymbolType> str) {
    ext::set < SymbolType > minimalAlphabet ( str.begin ( ), str.end ( ) );
    std::set_difference ( minimalAlphabet.begin ( ), minimalAlphabet.end ( ), getAlphabet ( ).begin ( ), getAlphabet ( ).end ( ), ext::callback_iterator ( [ ] ( const SymbolType & ) {
            throw exception::CommonException("Input symbols not in the alphabet.");
        } ) );
 
    m_Data = std::move(str);
}
 
template < class SymbolType >
bool CyclicString < SymbolType >::isEmpty() const {
    return this->m_Data.empty ( );
}
 
} /* namespace string */
 
namespace core {
 
template < class SymbolType >
class SetConstraint< string::CyclicString < SymbolType >, SymbolType, string::GeneralAlphabet > {
public:
    static bool used ( const string::CyclicString < SymbolType > & str, const SymbolType & symbol ) {
        const ext::vector<SymbolType>& content = str.getContent ( );
        return std::find(content.begin(), content.end(), symbol) != content.end();
    }
 
    static bool available ( const string::CyclicString < SymbolType > &, const SymbolType & ) {
        return true;
    }
 
    static void valid ( const string::CyclicString < SymbolType > &, const SymbolType & ) {
    }
};
 
template < class SymbolType >
struct normalize < string::CyclicString < SymbolType > > {
    static string::CyclicString < > eval ( string::CyclicString < SymbolType > && value ) {
        ext::set < DefaultSymbolType > alphabet = alphabet::SymbolNormalize::normalizeAlphabet ( std::move ( value ).getAlphabet ( ) );
        ext::vector < DefaultSymbolType > content = alphabet::SymbolNormalize::normalizeSymbols ( std::move ( value ).getContent ( ) );
        return string::CyclicString < > ( std::move ( alphabet ), std::move ( content ) );
    }
};
 
} /* namespace core */
 
extern template class string::CyclicString < >;