FockStateRule.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_FOCK_STATE_RULE
#define COM_DAFER45_TBTK_FOCK_STATE_RULE
 
#include "TBTK/FockState.h"
#include "TBTK/BitRegister.h"
#include "TBTK/ExtensiveBitRegister.h"
#include "TBTK/LadderOperator.h"
 
namespace TBTK{
 
template<typename BIT_REGISTER>
class FockSpace;
 
namespace FockStateRule{
 
class WrapperRule;
 
class FockStateRule{
public:
    enum class FockStateRuleID {
        WrapperRule = 0,
        SumRule = 1,
        DifferenceRule = 2
    };
 
    FockStateRule(FockStateRuleID fockStateRuleID);
 
    virtual ~FockStateRule();
 
    virtual FockStateRule* clone() const = 0;
 
    virtual WrapperRule createNewRule(
        const LadderOperator<BitRegister> &ladderOperator
    ) const = 0;
 
    virtual WrapperRule createNewRule(
        const LadderOperator<ExtensiveBitRegister> &ladderOperator
    ) const = 0;
 
    virtual bool isSatisfied(
        const FockSpace<BitRegister> &fockSpace,
        const FockState<BitRegister> &fockState
    ) const = 0;
 
    virtual bool isSatisfied(
        const FockSpace<ExtensiveBitRegister> &fockSpace,
        const FockState<ExtensiveBitRegister> &fockState
    ) const = 0;
 
    virtual bool operator==(const FockStateRule &rhs) const = 0;
 
    friend WrapperRule operator*(
        const LadderOperator<BitRegister> &ladderOperator,
        const FockStateRule &fockStateRule
    );
 
    friend WrapperRule operator*(
        const LadderOperator<ExtensiveBitRegister> &ladderOperator,
        const FockStateRule &fockStateRule
    );
 
    FockStateRuleID getFockStateRuleID() const;
 
    virtual void print() const = 0;
private:
    FockStateRuleID fockStateRuleID;
};
 
inline FockStateRule::FockStateRuleID FockStateRule::getFockStateRuleID() const{
    return fockStateRuleID;
}
 
};  //End of namespace FockSpaceRule
};  //End of namespace TBTK
 
#endif