SumRule.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_SUM_RULE
#define COM_DAFER45_TBTK_SUM_RULE

#include "TBTK/FockSpace.h"
#include "TBTK/FockStateRule/FockStateRule.h"
#include "TBTK/Index.h"

#include <initializer_list>
#include <vector>

namespace TBTK{
namespace FockStateRule{

class SumRule : public FockStateRule{
public:
    SumRule(
        std::initializer_list<Index> stateIndices,
        int numParticles
    );

    SumRule(
        std::vector<Index> stateIndices,
        int numParticles
    );

    virtual ~SumRule();

    virtual SumRule* clone() const;

    virtual WrapperRule createNewRule(
        const LadderOperator<BitRegister> &ladderOperator
    ) const;

    virtual WrapperRule createNewRule(
        const LadderOperator<ExtensiveBitRegister> &ladderOperator
    ) const;

    virtual bool isSatisfied(
        const FockSpace<BitRegister> &fockSpace,
        const FockState<BitRegister> &fockState
    ) const;

    virtual bool isSatisfied(
        const FockSpace<ExtensiveBitRegister> &fockSpace,
        const FockState<ExtensiveBitRegister> &fockState
    ) const;

    virtual bool operator==(const FockStateRule &rhs) const;

    virtual void print() const;
private:
    std::vector<Index> stateIndices;

    int numParticles;
};

};  //End of namespace FockStateRule
};  //End of namespace TBTK

#endif