StateTreeNode.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_STATE_TREE_NODE
#define COM_DAFER45_TBTK_STATE_TREE_NODE

#include "TBTK/AbstractState.h"
#include "TBTK/StateSet.h"

namespace TBTK{

class StateTreeNode{
public:
    StateTreeNode(
        std::initializer_list<double> center,
        double halfSize,
        int maxDepth = 10
    );

    StateTreeNode(
        std::vector<double> center,
        double halfSize,
        int maxDepth = 10
    );

    StateTreeNode(
        const StateSet &stateSet,
        int maxDepth = 10,
        double centerShiftMultiplier = 3.14 //Best choice of default number not known. Small integers and common ratios and trancendentals are probably all bad choices.
    );

    ~StateTreeNode();

    void add(AbstractState *state);

    std::vector<const AbstractState*>* getOverlappingStates(
        std::initializer_list<double> coordinates,
        double extent
    ) const;

    std::vector<const AbstractState*>* getOverlappingStates(
        std::vector<double> coordinates,
        double extent
    ) const;

    const std::vector<double>& getCoordinates() const;

    double getRadius() const;
private:
    std::vector<StateTreeNode*> stateTreeNodes;

    std::vector<AbstractState*> states;

    std::vector<double> center;

    double halfSize;

    static constexpr double ROUNDOFF_MARGIN_MULTIPLIER = 0.99;

    int maxDepth;

    const int numSpacePartitions;

    bool addRecursive(AbstractState* state);

    void getOverlappingStatesRecursive(
        std::vector<const AbstractState*>* overlappingStates,
        std::vector<double> coordinates,
        double extent
    ) const;
};

};  //End namespace TBTK

#endif