APIGGeminalCoefficients.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/Matrix.hpp"
#include "QCModel/CI/LinearExpansion.hpp"
#include "QCModel/Geminals/GeminalCoefficientsInterface.hpp"
 
 
namespace GQCP {
 
 
class APIGGeminalCoefficients: public GeminalCoefficientsInterface {
private:
    size_t K;           // the number of spatial orbitals corresponding to these geminal coefficients
    size_t N_P;         // the number of electron pairs (i.e. the number of geminals) corresponding to these geminal coefficients
    MatrixX<double> G;  // the APIG geminal coefficients
 
 
public:
    // CONSTRUCTORS
 
    APIGGeminalCoefficients(const MatrixX<double>& G);
 
    APIGGeminalCoefficients(const size_t N_P, const size_t K);
 
 
    // DESTRUCTOR
 
    ~APIGGeminalCoefficients() override;
 
 
    // OPERATORS
 
    double operator()(const size_t i, const size_t p) const;
 
 
    // NAMED CONSTRUCTORS
 
    static APIGGeminalCoefficients FromColumnMajor(const VectorX<double>& g, const size_t N_P, const size_t K);
 
    static APIGGeminalCoefficients FromRowMajor(const VectorX<double>& g, const size_t N_P, const size_t K);
 
 
    // STATIC PUBLIC METHODS
 
    static size_t numberOfGeminalCoefficients(const size_t N_P, const size_t K);
 
 
    // PUBLIC METHODS
 
    const MatrixX<double>& asMatrix() const { return this->G; };
 
    double overlap(const SpinUnresolvedONV& onv) const override;
};
 
 
}  // namespace GQCP