AdjacencyMatrix.hpp

Go to the documentation of this file.

// This file is part of GQCG-GQCP.
//
// Copyright (C) 2017-2020  the GQCG developers
//
// GQCG-GQCP 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.
//
// GQCG-GQCP 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 GQCG-GQCP.  If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
 
#include "Mathematical/Representation/SquareMatrix.hpp"
 
 
namespace GQCP {
 
 
class AdjacencyMatrix {
private:
    // The matrix representation of the adjacency matrix.
    SquareMatrix<size_t> A;
 
 
public:
    /*
     *  MARK: Constructors
     */
 
    AdjacencyMatrix(const SquareMatrix<size_t>& A);
 
 
    /*
     *  MARK: Named constructors
     */
 
    static AdjacencyMatrix Cyclic(const size_t n);
 
    static AdjacencyMatrix Linear(const size_t n);
 
 
    /*
     *  MARK: Access
     */
 
    const SquareMatrix<size_t>& matrix() const { return this->A; }
 
    SquareMatrix<size_t>& matrix() { return this->A; }
};
 
 
}  // namespace GQCP