BasicState.h

/* Copyright 2016 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef COM_DAFER45_TBTK_BASIC_STATE
#define COM_DAFER45_TBTK_BASIC_STATE

#include "AbstractState.h"
#include "Index.h"
#include "DefaultOperator.h"

#include <complex>
#include <tuple>

namespace TBTK{

class BasicState : public AbstractState{
public:
    BasicState(const Index &index, const Index &unitCellIndex = {});

    virtual ~BasicState();

    virtual BasicState* clone() const;

    void addOverlap(
        std::complex<double> overlap,
        const Index &braIndex,
        const Index &braRelativeUnitCell = {}
    );

    void addMatrixElement(
        std::complex<double> matrixElement,
        const Index &bra,
        const Index &braRelativeUnitCell = {}
    );

    virtual std::complex<double> getOverlap(const AbstractState &bra) const;

    virtual std::complex<double> getMatrixElement(
        const AbstractState &bra,
        const AbstractOperator &o = DefaultOperator()
    ) const;
private:
    std::vector<std::tuple<std::complex<double>, Index, Index>> overlaps;

    std::vector<std::tuple<std::complex<double>, Index, Index>> matrixElements;
};

};  //End of namespace TBTK

#endif