TreeNode.h

Go to the documentation of this file.

/* 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_TREE_NODE
#define COM_DAFER45_TBTK_TREE_NODE

#include <vector>
#include "HoppingAmplitude.h"

namespace TBTK{

class TreeNode{
public:
    int basisIndex;

    int basisSize;

    std::vector<HoppingAmplitude> hoppingAmplitudes;

    std::vector<TreeNode> children;

    TreeNode();

    void add(HoppingAmplitude ha);

    const TreeNode* getSubTree(const Index &subspace) const;

    bool isProperSubspace(const Index &subspace);

    const std::vector<HoppingAmplitude>* getHAs(Index index) const;

    int getBasisIndex(const Index &index) const;

    Index getPhysicalIndex(int basisIndex) const;

    void generateBasisIndices();

    void sort(TreeNode *rootNode);

    void print();

    class Iterator{
    public:
        const TreeNode* tree;

        std::vector<int> currentIndex;

        int currentHoppingAmplitude;

        Iterator(const TreeNode *tree);

        void reset();

        void searchNextHA();

        const HoppingAmplitude* getHA() const;
    private:
        bool searchNext(const TreeNode *treeNode, unsigned int subindex);
    };

    Iterator begin();
private:
    bool isPotentialBlockSeparator;

    void add(HoppingAmplitude &ha, unsigned int subindex);

    const TreeNode* getSubTree(
        const Index &subspace,
        unsigned int subindex
    ) const;

    bool isProperSubspace(const Index &subspace, unsigned int subindex);

    const std::vector<HoppingAmplitude>* getHAs(
        Index index,
        unsigned int subindex
    ) const;

    int getBasisIndex(const Index &index, unsigned int subindex) const;

    void getPhysicalIndex(int basisIndex, std::vector<int> *indices) const;

    int getMinIndex() const;

    int getMaxIndex() const;

    int generateBasisIndices(int i);

    void print(unsigned int subindex);

    HoppingAmplitude getFirstHA() const;
};

};  //End of namespace TBTK

#endif