NvBlastFamilyGraph.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2016-2020 NVIDIA Corporation. All rights reserved.


#ifndef NVBLASTFAMILYGRAPH_H
#define NVBLASTFAMILYGRAPH_H


#include "NvBlastSupportGraph.h"
#include "NvBlastFixedArray.h"
#include "NvBlastFixedBitmap.h"
#include "NvBlastFixedBoolArray.h"
#include "NvBlastMath.h"
#include "NvBlastFixedPriorityQueue.h"
#include "NvBlastMemory.h"


namespace Nv
{
namespace Blast
{


typedef uint32_t NodeIndex;
typedef NodeIndex IslandId;
typedef uint32_t ActorIndex;

class FamilyGraph
{
public:


    FamilyGraph(const SupportGraph* graph);


    static size_t   requiredMemorySize(uint32_t nodeCount, uint32_t bondCount)
    {
        return fillMemory(nullptr, nodeCount, bondCount);
    }



    void            initialize(ActorIndex actorIndex, const SupportGraph* graph);

    bool            notifyEdgeRemoved(ActorIndex actorIndex, NodeIndex node0, NodeIndex node1, const SupportGraph* graph);
    bool            notifyEdgeRemoved(ActorIndex actorIndex, NodeIndex node0, NodeIndex node1, uint32_t bondIndex, const SupportGraph* graph);

    bool            notifyNodeRemoved(ActorIndex actorIndex, NodeIndex nodeIndex, const SupportGraph* graph);

    uint32_t        findIslands(ActorIndex actorIndex, void* scratch, const SupportGraph* graph);

    static size_t   findIslandsRequiredScratch(uint32_t graphNodeCount);



    NvBlastBlockData(IslandId, m_islandIdsOffset, getIslandIds);

    NvBlastBlockData(NodeIndex, m_dirtyNodeLinksOffset, getDirtyNodeLinks);

    NvBlastBlockData(uint32_t, m_firstDirtyNodeIndicesOffset, getFirstDirtyNodeIndices);

    NvBlastBlockData(NodeIndex, m_fastRouteOffset, getFastRoute);

    NvBlastBlockData(uint32_t, m_hopCountsOffset, getHopCounts);

    NvBlastBlockData(FixedBoolArray, m_isEdgeRemovedOffset, getIsEdgeRemoved);

    NvBlastBlockData(FixedBoolArray, m_isNodeInDirtyListOffset, getIsNodeInDirtyList);



    uint32_t    getEdgesCount(const SupportGraph* graph) const;
    bool        hasEdge(NodeIndex node0, NodeIndex node1, const SupportGraph* graph) const;
    bool        canFindRoot(NodeIndex startNode, NodeIndex targetNode, FixedArray<NodeIndex>* visitedNodes, const SupportGraph* graph);


private:

    FamilyGraph& operator = (const FamilyGraph&);


    struct TraversalState
    {
        NodeIndex mNodeIndex;
        uint32_t mCurrentIndex;
        uint32_t mPrevIndex;
        uint32_t mDepth;

        TraversalState()
        {
        }

        TraversalState(NodeIndex nodeIndex, uint32_t currentIndex, uint32_t prevIndex, uint32_t depth) :
            mNodeIndex(nodeIndex), mCurrentIndex(currentIndex), mPrevIndex(prevIndex), mDepth(depth)
        {
        }
    };

    struct QueueElement
    {
        TraversalState* mState;
        uint32_t mHopCount;

        QueueElement()
        {
        }

        QueueElement(TraversalState* state, uint32_t hopCount) : mState(state), mHopCount(hopCount)
        {
        }
    };

    struct NodeComparator
    {
        NodeComparator()
        {
        }

        bool operator() (const QueueElement& node0, const QueueElement& node1) const
        {
            return node0.mHopCount < node1.mHopCount;
        }
    private:
        NodeComparator& operator = (const NodeComparator&);
    };

    typedef FixedPriorityQueue<QueueElement, NodeComparator> NodePriorityQueue;



    static size_t   fillMemory(FamilyGraph* familyGraph, uint32_t nodeCount, uint32_t bondCount);

    bool            findRoute(NodeIndex startNode, NodeIndex targetNode, IslandId islandId, FixedArray<TraversalState>* visitedNodes, FixedBitmap* isNodeWitness, NodePriorityQueue* priorityQueue, const SupportGraph* graph);

    bool            tryFastPath(NodeIndex startNode, NodeIndex targetNode, IslandId islandId, FixedArray<TraversalState>* visitedNodes, FixedBitmap* isNodeWitness, const SupportGraph* graph);

    void            unwindRoute(uint32_t traversalIndex, NodeIndex lastNode, uint32_t hopCount, IslandId id, FixedArray<TraversalState>* visitedNodes);

    void            addToDirtyNodeList(ActorIndex actorIndex, NodeIndex node);

    NodeIndex       getAdjacentNode(uint32_t adjacencyIndex, const SupportGraph* graph) const
    {
        const uint32_t bondIndex = graph->getAdjacentBondIndices()[adjacencyIndex];
        return getIsEdgeRemoved()->test(bondIndex) ? invalidIndex<uint32_t>() : graph->getAdjacentNodeIndices()[adjacencyIndex];
    }

};


} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTFAMILYGRAPH_H