/** \file
 * \brief implementation of the class BoyerMyrvoldInit
 *
 * \author Jens Schmidt
 *
 * \par License:
 * This file is part of the Open Graph Drawing Framework (OGDF).
 *
 * \par
 * Copyright (C)<br>
 * See README.md in the OGDF root directory for details.
 *
 * \par
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * Version 2 or 3 as published by the Free Software Foundation;
 * see the file LICENSE.txt included in the packaging of this file
 * for details.
 *
 * \par
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * \par
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, see
 * http://www.gnu.org/copyleft/gpl.html
 */

#include <ogdf/basic/Array.h>
#include <ogdf/basic/ArrayBuffer.h>
#include <ogdf/basic/Graph.h>
#include <ogdf/basic/GraphList.h>
#include <ogdf/basic/List.h>
#include <ogdf/basic/Math.h>
#include <ogdf/basic/SList.h>
#include <ogdf/basic/basic.h>
#include <ogdf/basic/comparer.h>
#include <ogdf/planarity/boyer_myrvold/BoyerMyrvoldInit.h>
#include <ogdf/planarity/boyer_myrvold/BoyerMyrvoldPlanar.h>

#include <limits>

namespace ogdf {
namespace boyer_myrvold {

// constructor
BoyerMyrvoldInit::BoyerMyrvoldInit(BoyerMyrvoldPlanar* pBM)
	: m_g(pBM->m_g)
	,
	// initialize Members of BoyerMyrvoldPlanar
	m_embeddingGrade(pBM->m_embeddingGrade)
	, m_randomness(pBM->m_randomness)
	, m_edgeCosts(pBM->m_edgeCosts)
	, m_rand(pBM->m_rand)
	,

	m_realVertex(pBM->m_realVertex)
	, m_dfi(pBM->m_dfi)
	, m_nodeFromDFI(pBM->m_nodeFromDFI)
	, m_link(pBM->m_link)
	, m_adjParent(pBM->m_adjParent)
	, m_leastAncestor(pBM->m_leastAncestor)
	, m_edgeType(pBM->m_edgeType)
	, m_lowPoint(pBM->m_lowPoint)
	, m_highestSubtreeDFI(pBM->m_highestSubtreeDFI)
	, m_separatedDFSChildList(pBM->m_separatedDFSChildList)
	, m_pNodeInParent(pBM->m_pNodeInParent) {
	OGDF_ASSERT(pBM != nullptr);
	OGDF_ASSERT(m_embeddingGrade <= BoyerMyrvoldPlanar::EmbeddingGrade::doNotFind
			|| m_highestSubtreeDFI.graphOf() == &m_g);
}

// start DFS-traversal
void BoyerMyrvoldInit::computeDFS() {
	// compute random edge costs
	EdgeArray<int> costs;
	const EdgeArray<int>* costsToUse = nullptr;

	if (m_edgeCosts != nullptr) { // do we have edge costs?
		if (m_randomness > 0) {
			// perturb edge costs
			costs.init(m_g);

			int minCost = std::numeric_limits<int>::max();
			int maxCost = std::numeric_limits<int>::min();

			for (edge e : m_g.edges) {
				int c = (*m_edgeCosts)[e];
				Math::updateMin(minCost, c);
				Math::updateMax(maxCost, c);
			}

			for (edge e : m_g.edges) {
				costs[e] = minCost
						+ (int)((1 - m_randomness) * ((*m_edgeCosts)[e] - minCost)
								+ m_randomness * (maxCost - minCost) * randomDouble(0, 1));
			}

			costsToUse = &costs;
		} else {
			// use original edge costs
			costsToUse = m_edgeCosts;
		}
	}

	ArrayBuffer<adjEntry> stack;
	int nextDFI = 1;
	const int numberOfNodes = m_g.numberOfNodes();

	SListPure<node> list;
	m_g.allNodes(list);

	// get random dfs-tree, if wanted
	if (m_randomness > 0) {
		list.permute();
	}

	for (node v : list) {
		if (v->degree() == 0) {
			m_dfi[v] = nextDFI;
			m_leastAncestor[v] = nextDFI;
			m_nodeFromDFI[nextDFI] = v;
			++nextDFI;
		} else {
			if (costsToUse != nullptr) {
				SList<adjEntry> adjList;
				v->allAdjEntries(adjList);
				// sort in ascending order of weight to hopefully find heavy DFS tree
				adjList.quicksort(GenericComparer<adjEntry, int>(*costsToUse));
				m_g.sort(v, adjList);
			}
			stack.push(v->firstAdj());
		}
	}

	while (nextDFI <= numberOfNodes) {
		OGDF_ASSERT(!stack.empty());
		adjEntry prnt = stack.popRet();
		node v = prnt->theNode();
		// check, if node v was visited before.
		if (m_dfi[v] != 0) {
			continue;
		}
		// parentNode=nullptr on first node on connected component
		node parentNode = prnt->twinNode();
		if (m_dfi[parentNode] == 0) {
			parentNode = nullptr;
		}

		// if not, mark node as visited and initialize NodeArrays
		m_dfi[v] = nextDFI;
		m_leastAncestor[v] = nextDFI;
		m_nodeFromDFI[nextDFI] = v;
		++nextDFI;

		// push all adjacent nodes onto stack
		for (adjEntry adj : v->adjEntries) {
			edge e = adj->theEdge();
			if (adj == prnt && parentNode != nullptr) {
				continue;
			}

			// check for self-loops and dfs- and dfs-parallel edges
			node w = adj->twinNode();

			if (m_dfi[w] == 0) {
				// Careful: we keep m_dfi[w] == 0.
				// Edge e might still turn into a backedge later.
				// Investigating edges in ascending order of weights makes sense here.
				m_edgeType[e] = BoyerMyrvoldEdgeType::Dfs;
				m_adjParent[w] = adj;
				m_link[BoyerMyrvoldPlanar::DirectionCW][w] = adj;
				m_link[BoyerMyrvoldPlanar::DirectionCCW][w] = adj;

				// found new dfs-edge: preorder
				stack.push(adj->twin());
			} else if (w == v) {
				// found self-loop
				m_edgeType[e] = BoyerMyrvoldEdgeType::Selfloop;
			} else {
				// node w already has been visited and is an dfs-ancestor of v
				OGDF_ASSERT(m_dfi[w] < m_dfi[v]);
				if (w == parentNode) {
					// found parallel edge of dfs-parent-edge
					m_edgeType[e] = BoyerMyrvoldEdgeType::DfsParallel;
				} else {
					// found backedge
					m_edgeType[e] = BoyerMyrvoldEdgeType::Back;
					// set least Ancestor
					if (m_dfi[w] < m_leastAncestor[v]) {
						m_leastAncestor[v] = m_dfi[w];
					}
				}
			}
		}
	}
}

// creates a virtual vertex of vertex father and embeds it as
// root in the biconnected child component containing of one edge
void BoyerMyrvoldInit::createVirtualVertex(const adjEntry father) {
	// check that adjEntry is valid
	OGDF_ASSERT(father != nullptr);

	// create new virtual Vertex and copy properties from non-virtual node
	const node virt = m_g.newNode();
	m_realVertex[virt] = father->theNode();
	m_dfi[virt] = -m_dfi[father->twinNode()];
	m_nodeFromDFI[m_dfi[virt]] = virt;

	// set links for traversal of bicomps
	m_link[BoyerMyrvoldPlanar::DirectionCW][virt] = father->twin();
	m_link[BoyerMyrvoldPlanar::DirectionCCW][virt] = father->twin();

	// move edge to new virtual Vertex
	edge e = father->theEdge();
	if (e->source() == father->theNode()) {
		// e is outgoing edge
		m_g.moveSource(e, virt);
	} else {
		// e is ingoing edge
		m_g.moveTarget(e, virt);
	}
}

// calculates the lowpoints
void BoyerMyrvoldInit::computeLowPoints() {
	node w;
	adjEntry adj, lastAdj;

	for (int i = m_g.numberOfNodes(); i >= 1; --i) {
		const node v = m_nodeFromDFI[i];

		// initialize lowpoints with least Ancestors and highpoints with dfi of node
		m_lowPoint[v] = m_leastAncestor[v];
		if (m_embeddingGrade > BoyerMyrvoldPlanar::EmbeddingGrade::doNotFind) {
			m_highestSubtreeDFI[v] = i;
		}

		// set the lowPoint of v by minimizing over its children lowPoints
		// create virtual vertex for each child
		adj = v->firstAdj();
		while (adj) {
			lastAdj = adj;
			adj = adj->succ();

			// avoid self-loops, parallel- and backedges
			if (m_edgeType[lastAdj->theEdge()] != BoyerMyrvoldEdgeType::Dfs) {
				continue;
			}
			w = lastAdj->twinNode();

			// avoid parent dfs-node
			if (m_dfi[w] <= i) {
				continue;
			}

			// set lowPoints and highpoints
			if (m_lowPoint[w] < m_lowPoint[v]) {
				m_lowPoint[v] = m_lowPoint[w];
			}
			if (m_embeddingGrade > BoyerMyrvoldPlanar::EmbeddingGrade::doNotFind
					&& m_highestSubtreeDFI[w] > m_highestSubtreeDFI[v]) {
				m_highestSubtreeDFI[v] = m_highestSubtreeDFI[w];
			}

			// create virtual vertex for each dfs-child
			createVirtualVertex(lastAdj);
		}
	}
}

// compute the separated DFS children for all nodes in ascending order of
// their lowpoint values in linear time
void BoyerMyrvoldInit::computeDFSChildLists() {
	// Bucketsort by lowpoint values
	// Below is the bucket function for lowPoint buckets.
	// Parameter lowPoint may not be deleted til destruction of this class.
	class BucketLowPoint : public BucketFunc<node> {
	public:
		explicit BucketLowPoint(const NodeArray<int>& lowPoint) : m_pLow(&lowPoint) { }

		// This function has to be derived from BucketFunc, it gets the buckets from lowPoint-Array
		int getBucket(const node& v) override { return (*m_pLow)[v]; }

	private:
		// Stored to be able to get the buckets
		const NodeArray<int>* m_pLow;
	} blp(m_lowPoint);

	// copy all non-virtual nodes in a list and sort them with Bucketsort
	SListPure<node> allNodes;
	for (node v : m_g.nodes) {
		if (m_dfi[v] > 0) {
			allNodes.pushBack(v);
		}
	}
	allNodes.bucketSort(1, m_nodeFromDFI.high(), blp);

	// build DFS-child list
	for (node v : allNodes) {
		OGDF_ASSERT(m_dfi[v] > 0);

		// if node is not root: insert node after last element of parent's DFSChildList
		// to achieve constant time deletion later:
		// set a pointer for each node to predecessor of his representative in the list
		if (m_adjParent[v] != nullptr) {
			OGDF_ASSERT(m_realVertex[m_adjParent[v]->theNode()] != nullptr);

			m_pNodeInParent[v] =
					m_separatedDFSChildList[m_realVertex[m_adjParent[v]->theNode()]].pushBack(v);

			OGDF_ASSERT(m_pNodeInParent[v].valid());
			OGDF_ASSERT(v == *m_pNodeInParent[v]);
		} else {
			m_pNodeInParent[v] = nullptr;
		}
	}
}

}
}
