TAPsDatabaseDowkerNotation.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsDatabaseDowkerNotation.hpp


SUKITTI PUNAK   (04/25/2008)
UPDATE          (12/09/2010)
******************************************************************************/
#ifndef TAPs_DATABASE_DOWKER_NOTATION_HPP
#define TAPs_DATABASE_DOWKER_NOTATION_HPP

#include "../Core/TAPsStdLib.hpp"

BEGIN_NAMESPACE_TAPs__Data
//=============================================================================
class DatabaseDowkerNotation {
//=============================================================================
public:
    // Member Functions -------------------------------------------------------
    friend std::ostream & operator<< ( std::ostream &output, DatabaseDowkerNotation const &data )
    {
        output << "DatabaseDowkerNotation contains:";
        for ( unsigned int i = 0; i < LIST_SIZE; ++i ) {
            if ( i % 8 == 0 )   output << "\n\t";
            else                output << " ";
            output << KnotNames[i];
        }
        output << "\n";
        return output;
    }

    static const int * GetEntry ( unsigned int i )
    {
        if ( i >= DATA_LIST_SIZE ) return EntryAccess[DATA_LIST_SIZE];
        return EntryAccess[i];
    }

    static std::string const & GetKnotName ( unsigned int i )
    {
        if ( i >= LIST_SIZE ) return KnotNames[LIST_SIZE];
        return KnotNames[i];
    }

    static std::string GetStrEntry ( unsigned int );

    static int FindKnotOfDowkerNotation ( 
        unsigned int numPairs, int * dowkerNotation, 
        std::string * knotName = NULL                
    );

    //-------------------------------------------------------------------------
    // Data Members -----------------------------------------------------------
    enum KNOT {
        UNDEFINED = -1,
        HALF_NEG = 0,   HALF_POS,
        DOUBLE_NEG,     DOUBLE_POS,
        SQUARE_NEG,     SQUARE_POS,
        SURGEONS_NEG,   SURGEONS_POS,

        HALF_NEG_WITH_A_CROSS_NEG,
        HALF_NEG_WITH_A_CROSS_POS,
        HALF_POS_WITH_A_CROSS_NEG,
        HALF_POS_WITH_A_CROSS_POS,

        // For fixing/forming the knot shape -- do not include in knot checking
        HALF_NEG_FOLLOWED_BY_HALF_NEG,
        HALF_NEG_FOLLOWED_BY_HALF_POS,      // same as SQUARE_NEG
        HALF_POS_FOLLOWED_BY_HALF_NEG,      // same as SQUARE_POS
        HALF_POS_FOLLOWED_BY_HALF_POS,
        DOUBLE_NEG_FOLLOWED_BY_HALF_NEG,
        DOUBLE_NEG_FOLLOWED_BY_HALF_POS,    // same as SURGEON_NEG
        DOUBLE_POS_FOLLOWED_BY_HALF_NEG,    // same as SURGEON_POS
        DOUBLE_POS_FOLLOWED_BY_HALF_POS,
    };
    //-------------------------------------------------------------------------
//=============================================================================
protected:
    // Member Functions -------------------------------------------------------
    //-------------------------------------------------------------------------
    // Data Members -----------------------------------------------------------
    //-------------------------------------------------------------------------
//=============================================================================
private:
    // Member Functions -------------------------------------------------------
    //-------------------------------------------------------------------------
    // Data Members -----------------------------------------------------------
        static const std::string KnotNames[];   
        static const unsigned int LIST_SIZE;        
        static const unsigned int DATA_LIST_SIZE;   
        static const int HalfNeg[];             
        static const int HalfPos[];             
        static const int DoubleNeg[];           
        static const int DoublePos[];           
        static const int SquareNeg[];           
        static const int SquarePos[];           
        static const int SurgeonsKnotNeg[];     
        static const int SurgeonsKnotPos[];     

        static const int HalfNeg_WithA_CrossNeg[];      
        static const int HalfNeg_WithA_CrossPos[];      
        static const int HalfPos_WithA_CrossNeg[];      
        static const int HalfPos_WithA_CrossPos[];      

        static const int UndefinedData[];

        //static int DN_#_Pos_#[] = { #,   ...,   # };

        static int const * const EntryAccess[];
    //-------------------------------------------------------------------------
//=============================================================================
}; // END CLASS Skeleton
//=============================================================================
//=============================================================================
END_NAMESPACE_TAPs__Data
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
#if !defined( TAPs_USE_EXPORT )
    #include "TAPsDatabaseDowkerNotation.cpp"
#endif
//-----------------------------------------------------------------------------
#endif
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----