GraphColoring/GraphCore.h

Go to the documentation of this file.

/************************************************************************************
    Copyright (C) 2005-2008 Assefaw H. Gebremedhin, Arijit Tarafdar, Duc Nguyen,
    Alex Pothen

    This file is part of ColPack.

    ColPack is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    ColPack 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with ColPack.  If not, see <http://www.gnu.org/licenses/>.
************************************************************************************/

using namespace std;

#ifndef GRAPHCORE_H
#define GRAPHCORE_H
namespace ColPack
{
        class GraphCore
        {
        public: //DOCUMENTED

                void PrintVertexD1Neighbor(int VertexIndex, int excludedVertex = -1);
                void GetD1Neighbor(int VertexIndex, vector<int> &D1Neighbor, int excludedVertex = -1);

                void PrintVertexD2Neighbor(int VertexIndex);


                bool AreD2Neighbor(int VertexIndex1, int VertexIndex2);
                
                bool operator==(const GraphCore &other) const;
                bool areEqual(const GraphCore &other, bool structureOnly = 1) const;

        protected:

                int m_i_MaximumVertexDegree;
                int m_i_MinimumVertexDegree;

                double m_d_AverageVertexDegree;

                string m_s_InputFile;

                vector<int> m_vi_Vertices;

                vector<int> m_vi_Edges;

                vector<double> m_vd_Values; 

                map< int, map< int, int> > m_mimi2_VertexEdgeMap; //moved from int GraphColoring::AcyclicColoring()

                DisjointSets m_ds_DisjointSets; //moved from int GraphColoring::AcyclicColoring()
        public:

                //Virtual Destructor 1100
                virtual ~GraphCore() {}

                //Virtual Function 1101
                virtual void Initialize() = 0;

                //Virtual Function 1102
                virtual void Clear();

                //Public Function 1103
                int GetVertexCount();


                //Public Function 1104
                int GetEdgeCount();


                //Public Function 1105
                int GetMaximumVertexDegree();


                //Public Function 1106
                int GetMinimumVertexDegree();


                //Public Function 1107
                double GetAverageVertexDegree();


                //Public Function 1108
                string GetInputFile();

                //Public Function 1109
                void GetVertices(vector<int> &output) const;

                //Public Function 1110
                void GetEdges(vector<int> &output) const;

                //Public Function 1111
                void GetValues(vector<double> &output) const;

                void GetVertexEdgeMap(map< int, map< int, int> > &output);

                void GetDisjointSets(DisjointSets &output);


        };
}
#endif