Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Ordering] add ability to define order constraints within rank #302

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions lib/layout.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,18 @@ var Graph = require("./graphlib").Graph;

module.exports = layout;

function layout(g, opts) {
var time = opts && opts.debugTiming ? util.time : util.notime;
function layout(g, inputOpts) {
var opts = inputOpts || {};
var time = opts.debugTiming ? util.time : util.notime;
time("layout", function() {
var layoutGraph =
time(" buildLayoutGraph", function() { return buildLayoutGraph(g); });
time(" runLayout", function() { runLayout(layoutGraph, time); });
time(" runLayout", function() { runLayout(layoutGraph, time, opts); });
time(" updateInputGraph", function() { updateInputGraph(g, layoutGraph); });
});
}

function runLayout(g, time) {
function runLayout(g, time, opts) {
time(" makeSpaceForEdgeLabels", function() { makeSpaceForEdgeLabels(g); });
time(" removeSelfEdges", function() { removeSelfEdges(g); });
time(" acyclic", function() { acyclic.run(g); });
Expand All @@ -42,7 +43,7 @@ function runLayout(g, time) {
time(" normalize.run", function() { normalize.run(g); });
time(" parentDummyChains", function() { parentDummyChains(g); });
time(" addBorderSegments", function() { addBorderSegments(g); });
time(" order", function() { order(g); });
time(" order", function() { order(g, opts); });
time(" insertSelfEdges", function() { insertSelfEdges(g); });
time(" adjustCoordinateSystem", function() { coordinateSystem.adjust(g); });
time(" position", function() { position(g); });
Expand Down
16 changes: 13 additions & 3 deletions lib/order/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ module.exports = order;
*
* 1. Graph nodes will have an "order" attribute based on the results of the
* algorithm.
*
*/
function order(g) {
function order(g, opts) {
var maxRank = util.maxRank(g),
downLayerGraphs = buildLayerGraphs(g, _.range(1, maxRank + 1), "inEdges"),
upLayerGraphs = buildLayerGraphs(g, _.range(maxRank - 1, -1, -1), "outEdges");
Expand All @@ -37,15 +38,19 @@ function order(g) {
var bestCC = Number.POSITIVE_INFINITY,
best;

var constraints = opts.constraints || [];

for (var i = 0, lastBest = 0; lastBest < 4; ++i, ++lastBest) {
sweepLayerGraphs(i % 2 ? downLayerGraphs : upLayerGraphs, i % 4 >= 2);
sweepLayerGraphs(i % 2 ? downLayerGraphs : upLayerGraphs, i % 4 >= 2, constraints);

layering = util.buildLayerMatrix(g);
var cc = crossCount(g, layering);
if (cc < bestCC) {
lastBest = 0;
best = _.cloneDeep(layering);
bestCC = cc;
} else if (cc === bestCC) {
best = _.cloneDeep(layering);
}
}

Expand All @@ -58,8 +63,13 @@ function buildLayerGraphs(g, ranks, relationship) {
});
}

function sweepLayerGraphs(layerGraphs, biasRight) {
function sweepLayerGraphs(layerGraphs, biasRight, constraints) {
var cg = new Graph();

_.forEach(constraints, function(constraint) {
cg.setEdge(constraint.left, constraint.right);
});

_.forEach(layerGraphs, function(lg) {
var root = lg.graph().root;
var sorted = sortSubgraph(lg, root, cg, biasRight);
Expand Down
8 changes: 4 additions & 4 deletions test/order/order-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ describe("order", function() {
g.setPath(["a", "b", "c"]);
g.setEdge("b", "d");
g.setPath(["a", "e", "f"]);
order(g);
order(g, {});
var layering = util.buildLayerMatrix(g);
expect(crossCount(g, layering)).to.equal(0);
});
Expand All @@ -29,8 +29,8 @@ describe("order", function() {
// This graph resulted in a single crossing for previous versions of dagre.
_.forEach(["a", "d"], function(v) { g.setNode(v, { rank: 1 }); });
_.forEach(["b", "f", "e"], function(v) { g.setNode(v, { rank: 2 }); });
_.forEach(["c", "g"], function(v) { g.setNode(v, { rank: 3 }); });
order(g);
_.forEach(["c", "g"], function (v) { g.setNode(v, { rank: 3 }); });
order(g, {});
var layering = util.buildLayerMatrix(g);
expect(crossCount(g, layering)).to.equal(0);
});
Expand All @@ -40,7 +40,7 @@ describe("order", function() {
_.forEach(["b", "e", "g"], function(v) { g.setNode(v, { rank: 2 }); });
_.forEach(["c", "f", "h"], function(v) { g.setNode(v, { rank: 3 }); });
g.setNode("d", { rank: 4 });
order(g);
order(g, {});
var layering = util.buildLayerMatrix(g);
expect(crossCount(g, layering)).to.be.lte(1);
});
Expand Down