BipartiteGraphBicoloring/BipartiteGraphBicoloring.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 BIPARTITEGRAPHBICOLORING_H
#define BIPARTITEGRAPHBICOLORING_H

namespace ColPack
{
        class BipartiteGraphBicoloring : public BipartiteGraphOrdering
        {
        public: //DOCUMENTED

                //Public Function 3573
                void GetLeftVertexColors(vector<int> &output);

                //Public Function 3574
                void GetRightVertexColors(vector<int> &output);

                void GetRightVertexColors_Transformed(vector<int> &output);


                double** GetLeftSeedMatrix(int* ip1_SeedRowCount, int* ip1_SeedColumnCount);


                double** GetLeftSeedMatrix_unmanaged(int* ip1_SeedRowCount, int* ip1_SeedColumnCount);


                double** GetRightSeedMatrix(int* ip1_SeedRowCount, int* ip1_SeedColumnCount);


                double** GetRightSeedMatrix_unmanaged(int* ip1_SeedRowCount, int* ip1_SeedColumnCount);


                void GetSeedMatrix(double*** dp3_LeftSeed, int* ip1_LeftSeedRowCount, int* ip1_LeftSeedColumnCount, double*** dp3_RightSeed, int* ip1_RightSeedRowCount, int* ip1_RightSeedColumnCount);


                void GetSeedMatrix_unmanaged(double*** dp3_LeftSeed, int* ip1_LeftSeedRowCount, int* ip1_LeftSeedColumnCount, double*** dp3_RightSeed, int* ip1_RightSeedRowCount, int* ip1_RightSeedColumnCount);

        protected: //DOCUMENTED

                int i_LeftVertexDefaultColor;


                int i_RightVertexDefaultColor;


                int m_i_LeftVertexColorCount;


                int m_i_RightVertexColorCount;

                int m_i_VertexColorCount;


                vector<int> m_vi_LeftVertexColors;


                vector<int> m_vi_RightVertexColors;

                bool lseed_available;
                int i_lseed_rowCount;
                double** dp2_lSeed;

                bool rseed_available;
                int i_rseed_rowCount;
                double** dp2_rSeed;

                void Seed_init();
                void Seed_reset();

        private:

                //Private Function 3501
                void PresetCoveredVertexColors();

                //Private Function 3506
                int CheckVertexColoring(string s_VertexColoringVariant);

                //Private Function 3507
                int CalculateVertexColorClasses();

                //Private Function 3508
                int FixMinimalCoverStarBicoloring();

        protected:

                int m_i_ViolationCount;

                //int m_i_ColoringUnits; // used in ImplicitCoveringAcyclicBicoloring()

                int m_i_LargestLeftVertexColorClass;
                int m_i_LargestRightVertexColorClass;

                int m_i_LargestLeftVertexColorClassSize;
                int m_i_LargestRightVertexColorClassSize;

                int m_i_SmallestLeftVertexColorClass;
                int m_i_SmallestRightVertexColorClass;

                int m_i_SmallestLeftVertexColorClassSize;
                int m_i_SmallestRightVertexColorClassSize;

                int m_i_LargestVertexColorClass;
                int m_i_SmallestVertexColorClass;

                int m_i_LargestVertexColorClassSize;
                int m_i_SmallestVertexColorClassSize;

                double m_d_AverageLeftVertexColorClassSize;
                double m_d_AverageRightVertexColorClassSize;
                double m_d_AverageVertexColorClassSize;

                double m_d_ColoringTime;
                double m_d_CheckingTime;

                string m_s_VertexColoringVariant;

                vector<int> m_vi_LeftVertexColorFrequency;
                vector<int> m_vi_RightVertexColorFrequency;

        public:

                //Public Constructor 3551
                BipartiteGraphBicoloring();

                //Public Destructor 3552
                ~BipartiteGraphBicoloring();

                //Virtual Function 3553
                virtual void Clear();

                //Virtual Function 3554
                virtual void Reset();

                //Public Function 3562
                int ImplicitCoveringStarBicoloring();

                //Public Function 3560
                int ExplicitCoveringStarBicoloring();

                //Public Function 3559
                int ExplicitCoveringModifiedStarBicoloring();

                //Public Function 3564
                int ImplicitCoveringGreedyStarBicoloring();

                //Public Function 3556
                int MinimalCoveringRowMajorStarBicoloring();            //????

                //Public Function 3557
                int MinimalCoveringColumnMajorStarBicoloring();         //????

                //Public Function 3558
                int ImplicitCoveringConservativeStarBicoloring();       // CRASH

                //Public Function 3561
                int MinimalCoveringStarBicoloring();                            // CRASH

                //Public Function 3563
                int ImplicitCoveringRestrictedStarBicoloring();         // CRASH

                //Public Function 3565
                int CheckStarBicoloring();


                //Public Function 3568
                int GetLeftVertexColorCount();

                //Public Function 3569
                int GetRightVertexColorCount();

                //Public Function 3570
                int GetVertexColorCount();

                //Public Function 3571
                int GetViolationCount();

                int GetRightVertexDefaultColor();

                //Public Function 3572
                string GetVertexBicoloringVariant();
                string GetVertexColoringVariant();

                //Public Function 3575
                void PrintVertexBicolors();

                //Public Function 3576
                void PrintVertexBicoloringMetrics();

                //Public Function 3577
                void PrintVertexBicolorClasses();
                
                double GetVertexColoringTime();
        };
}
#endif