FMTMatrixBuild.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifdef FMTWITHOSI
 
#ifndef FMTmatrixbuild_Hm_included
#define FMTmatrixbuild_Hm_included
 
 
#include <vector>
#include <string>
#include <memory>
#include "FMTutility.h"
#include "FMTObject.h"
class OsiSolverInterface;
class CoinBuild;
 
 
namespace Models
 
{ 
    // DocString: FMTMatrixBuild
    class FMTEXPORT FMTMatrixBuild
    {
    public:
        // DocString: FMTMatrixBuild::swap
        void swap(FMTMatrixBuild& rhs);
        // DocString: FMTMatrixBuild::getColumnNames
        inline std::vector<std::string>& getColumnNames()
            {
            return m_columnnames;
            }
        // DocString: FMTMatrixBuild::getRowNames
        inline std::vector<std::string>& getRowNames()
            {
            return m_rownames;
            }
        // DocString: FMTMatrixBuild::formatAllNames
        void formatAllNames(bool shortformat);
        // DocString: FMTMatrixBuild::setColName
        void setColName(const std::string& name,const int& columnid);
        // DocString: FMTMatrixBuild::setRowName
        void setRowName(const std::string& name, const int& rowid);
        // DocString: FMTMatrixBuild::synchronize
        void synchronize(std::shared_ptr<OsiSolverInterface> solver);
        // DocString: FMTMatrixBuild()
        FMTMatrixBuild();
        // DocString: FMTMatrixBuild(const FMTMatrixBuild)
        FMTMatrixBuild(const FMTMatrixBuild& rhs);
        // DocString: FMTMatrixBuild::operator=
        FMTMatrixBuild& operator = (const FMTMatrixBuild& rhs);
        // DocString: ~FMTMatrixBuild()
        ~FMTMatrixBuild();
        // DocString: FMTMatrixBuild::addCol
        void addCol(int numberInColumn, const int * rows, const double * elements, double columnLower = 0.0,
            double columnUpper = std::numeric_limits<double>::max(), double objectiveValue = 0.0);
        // DocString: FMTMatrixBuild::addRow
        void addRow(int numberInRow, const int * columns, const double * elements,
            double rowLower = -std::numeric_limits<double>::max(), double rowUpper = std::numeric_limits<double>::max());
        // DocString: FMTMatrixBuild::deleteRow
        void deleteRow(const int& rowindex);
        // DocString: FMTMatrixBuild::deleteCol
        void deleteCol(const int& colindex);
        // DocString: FMTMatrixBuild::numberNewRows
        inline int numberNewRows() const
            {
            return m_rowscount;
            }
        // DocString: FMTMatrixBuild::numberNewCols
        inline int numberNewCols() const
            {
            return m_colscount;
            }
        // DocString: FMTMatrixBuild::numberOfDeletedRows
        inline int numberOfDeletedRows() const
            {
            return static_cast<int>(m_deletedconstraints.size());
            }
        // DocString: FMTMatrixBuild::numberOfDeletedCols
        inline int numberOfDeletedCols() const
            {
            return static_cast<int>(m_deletedvariables.size());
            }
        // DocString: FMTMatrixBuild::getDeletedConstraints
        inline const std::vector<int>& getDeletedConstraints() const
            {
            return m_deletedconstraints;
            }
        // DocString: FMTMatrixBuild::getDeletedVariables
        inline const std::vector<int>& getDeletedVariables() const
            {
            return m_deletedvariables;
            }
        // DocString: FMTMatrixBuild::sortAndCleanDeleted
        void sortAndCleanDeleted();
        // DocString: FMTMatrixBuild::getRowsToSynchronize
        std::string getRowsToSynchronize() const;
        // DocString: FMTMatrixBuild::getRowsToSynchronize
        std::string getColsToSynchronize() const;
        // DocString: FMTMatrixBuild::getRow
        int getRow(int whichRow, double &rowLower, double &rowUpper,
            std::vector<int>& indices, std::vector<double>&elements) const;
        // DocString: FMTMatrixBuild::getCol
        int getCol(int whichCol, double &colLower, double &colUpper, double &objectiveValue,
            std::vector<int>& indices, std::vector<double>&elements) const;
 
 
    private:
        // DocString: FMTMatrixBuild::lastcol
        int m_colscount;
        // DocString: FMTMatrixBuild::lastrow
        int m_rowscount;
        // DocString: FMTMatrixBuild::m_colsbuild
        std::unique_ptr<CoinBuild>m_colsbuild;
        // DocString: FMTMatrixBuild::m_rowsbuild
        std::unique_ptr<CoinBuild>m_rowsbuild;
        // DocString: FMTMatrixBuild::m_deletedconstraints
        std::vector<int>m_deletedconstraints;
        // DocString: FMTMatrixBuild::m_deletedvariables
        std::vector<int>m_deletedvariables;
        // DocString: FMTMatrixBuild::m_columnnames
        std::vector<std::string>m_columnnames;
        // DocString: FMTMatrixBuild::m_rownames
        std::vector<std::string>m_rownames;
        // DocString: FMTMatrixBuild::_sortElementsAndClean
        void _sortElementsAndClean(std::vector<int>& elements) const;
        // DocString: FMTMatrixBuild::_formatForMatrixName
        std::string _formatForMatrixName(std::string name, bool shortformat) const;
    };
}
 
#endif
#endif