@graphty/graph-samples 0.0.1 → 0.1.2

package/dist/src/generators/hyperbolic.js

@@ -0,0 +1,153 @@
+/**
+ * Random hyperbolic graphs (D. Krioukov, F. Papadopoulos, M. Kitsak, A. Vahdat and M. Boguna,
+ * "Hyperbolic geometry of complex networks", Phys. Rev. E 82, 036106, 2010,
+ * doi:10.1103/PhysRevE.82.036106): power-law degrees, high clustering and a native 2D embedding.
+ */
+import { detExp } from "../random/exp.js";
+import { detLog } from "../random/log.js";
+import { RandomStream, resolveSeed } from "../random/stream.js";
+import { detCosSinTurn } from "../random/trig.js";
+import { checkInt, EdgeBuffer, toGraph } from "./util.js";
+import { applyWeights } from "./weights.js";
+/** The largest node count of the O(n^2) pair loop. */
+const MAX_NODES = 20000;
+/**
+ * cosh(x) from detExp.
+ * @param x - the argument
+ * @returns cosh x
+ */
+function cosh(x) {
+    return (detExp(x) + detExp(-x)) / 2;
+}
+/**
+ * acosh(y) for y >= 1 from detLog.
+ * @param y - the argument
+ * @returns acosh y
+ */
+function acosh(y) {
+    return detLog(y + Math.sqrt((y - 1) * (y + 1)));
+}
+/**
+ * Check the options, compute the disk radius and draw the points.
+ * @param options - the options
+ * @returns the plan
+ */
+export function planHyperbolic(options) {
+    const { n, averageDegree, exponent } = options;
+    const temperature = options.temperature ?? 0;
+    checkInt("n", n, 0, MAX_NODES);
+    if (!(Number.isFinite(averageDegree) && averageDegree > 0)) {
+        throw new RangeError(`averageDegree must be a finite number > 0, got ${String(averageDegree)}`);
+    }
+    if (!(Number.isFinite(exponent) && exponent > 2)) {
+        throw new RangeError(`exponent must be a finite number > 2, got ${String(exponent)}`);
+    }
+    if (!(temperature >= 0 && temperature < 1)) {
+        throw new RangeError(`temperature must be in [0, 1), got ${String(temperature)}`);
+    }
+    const seed = resolveSeed(options.seed);
+    const alpha = (exponent - 1) / 2;
+    const xi = alpha / (alpha - 0.5);
+    let correction = 1;
+    if (temperature > 0) {
+        const cs = new Float64Array(2);
+        detCosSinTurn(temperature / 2, cs);
+        correction = (Math.PI * temperature) / cs[1];
+    }
+    const scale = ((2 * xi * xi * n) / (Math.PI * averageDegree)) * correction;
+    if (n >= 2 && !(scale > 1)) {
+        throw new RangeError(`averageDegree ${averageDegree} is too large for n = ${n}: the disk radius would be <= 0`);
+    }
+    const R = n >= 2 ? 2 * detLog(scale) : 0;
+    const coshAlphaR = cosh(alpha * R);
+    if (!Number.isFinite(coshAlphaR)) {
+        throw new RangeError(`exponent ${exponent} is too large: cosh(alpha R) overflows`);
+    }
+    const cosT = new Float64Array(n);
+    const sinT = new Float64Array(n);
+    const coshr = new Float64Array(n);
+    const sinhr = new Float64Array(n);
+    const x = new Float64Array(n);
+    const y = new Float64Array(n);
+    const radius = new Float64Array(n);
+    const cs = new Float64Array(2);
+    const stream = new RandomStream(seed, "hyperbolic-points", 0);
+    for (let i = 0; i < n; i++) {
+        stream.reset(i);
+        detCosSinTurn(stream.nextFloat(), cs);
+        const r = acosh(1 + (coshAlphaR - 1) * stream.nextFloat()) / alpha;
+        const er = detExp(r);
+        cosT[i] = cs[0];
+        sinT[i] = cs[1];
+        coshr[i] = (er + 1 / er) / 2;
+        sinhr[i] = (er - 1 / er) / 2;
+        radius[i] = r;
+        x[i] = r * cs[0];
+        y[i] = r * cs[1];
+    }
+    return { n, seed, temperature, R, coshR: cosh(R), cosT, sinT, coshr, sinhr, x, y, radius };
+}
+/**
+ * Rows [start, end) of the hyperbolic graph: row u holds the pairs (u, v), v = u + 1 .. n - 1 in
+ * ascending v, with cosh d = cosh r_u cosh r_v - sinh r_u sinh r_v cos(theta_u - theta_v) (the
+ * cosine of the angle difference expanded from the stored cosines and sines). At T = 0 the pair is
+ * an edge iff cosh d < cosh R (no draws). At T > 0 row u draws one nextFloat() t per pair from
+ * stream (seed, "hyperbolic", u) and the pair is an edge iff t < 1 / (1 + exp((d - R) / (2 T))),
+ * decided as acosh(cosh d) < R + 2 T ln((1 - t) / t) with no exp. Any split of [0, n) into
+ * consecutive ranges gives the whole graph.
+ * @param plan - the checked options and points
+ * @param start - the first row
+ * @param end - one past the last row
+ * @param out - receives the edges
+ */
+export function hyperbolicRows(plan, start, end, out) {
+    const { n, R, coshR, temperature, cosT, sinT, coshr, sinhr } = plan;
+    const stream = new RandomStream(plan.seed, "hyperbolic", 0);
+    for (let u = start; u < end; u++) {
+        stream.reset(u);
+        for (let v = u + 1; v < n; v++) {
+            const coshD = coshr[u] * coshr[v] - sinhr[u] * sinhr[v] * (cosT[u] * cosT[v] + sinT[u] * sinT[v]);
+            if (temperature === 0) {
+                if (coshD < coshR) {
+                    out.push(u, v);
+                }
+                continue;
+            }
+            const t = stream.nextFloat();
+            if (acosh(Math.max(1, coshD)) < R + 2 * temperature * detLog((1 - t) / t)) {
+                out.push(u, v);
+            }
+        }
+    }
+}
+/**
+ * A random hyperbolic graph (Krioukov et al. 2010): n points in a hyperbolic disk of radius R,
+ * angles uniform and radii with density proportional to sinh(alpha r), alpha = (gamma - 1) / 2,
+ * so the degrees follow a power law with exponent gamma. At temperature 0 two nodes are joined iff
+ * their hyperbolic distance is below R; at T > 0 with probability 1 / (1 + exp((d - R) / (2 T))).
+ *
+ * R comes from the paper's approximation of the mean degree, R = 2 ln(2 xi^2 n / (pi k)) with
+ * xi = alpha / (alpha - 1/2), times (pi T / sin(pi T)) inside the logarithm for T > 0. It is an
+ * approximation, so the measured mean degree only lands near `averageDegree`: measured at n = 3000
+ * and 10000, within about 10% for exponent >= 2.5 and T <= 0.7, but about 0.6x at exponent 2.2 and
+ * about 0.5x at T = 0.9 (the approximation degrades as gamma approaches 2 and T approaches 1).
+ *
+ * Node i draws its angle theta = 2 pi u and then its radius r = acosh(1 + (cosh(alpha R) - 1) u') /
+ * alpha (inverse CDF) from stream (seed, "hyperbolic-points", i); the pairs are decided by
+ * {@link hyperbolicRows}. Edges are the pairs (u, v), u < v, ascending u then v. Node columns (all
+ * Float64Array): `x`, `y` (the native polar embedding r cos theta, r sin theta) and `radius` (r).
+ *
+ * Cost: O(n^2) pairs (and one draw per pair at T > 0), so n is capped at 20000.
+ * ponytail: naive pair loop, n <= 20000; the band algorithm of M. von Looz, H. Meyerhenke and
+ * R. Prutkin, "Generating random hyperbolic graphs in subquadratic time", ISAAC 2015,
+ * doi:10.1007/978-3-662-48971-0_40, is the upgrade path.
+ * @param options - n, averageDegree, exponent, temperature and seed
+ * @returns the undirected graph
+ */
+export function hyperbolicGraph(options) {
+    const plan = planHyperbolic(options);
+    const out = new EdgeBuffer(Math.ceil(plan.n * options.averageDegree * 0.75) + 16);
+    hyperbolicRows(plan, 0, plan.n, out);
+    return applyWeights(toGraph(plan.n, out, false, { x: plan.x, y: plan.y, radius: plan.radius }), options);
+}
+//# sourceMappingURL=hyperbolic.js.map

package/dist/src/generators/hyperbolic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hyperbolic.js","sourceRoot":"","sources":["../../../src/generators/hyperbolic.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAsB,MAAM,cAAc,CAAC;AAEhE,sDAAsD;AACtD,MAAM,SAAS,GAAG,KAAK,CAAC;AAiCxB;;;;GAIG;AACH,SAAS,IAAI,CAAC,CAAS;IACnB,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,SAAS,KAAK,CAAC,CAAS;IACpB,OAAO,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAA0B;IACrD,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC;IAC7C,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/B,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,UAAU,CAAC,kDAAkD,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,UAAU,CAAC,6CAA6C,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;IACD,IAAI,CAAC,CAAC,WAAW,IAAI,CAAC,IAAI,WAAW,GAAG,CAAC,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,UAAU,CAAC,sCAAsC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvC,MAAM,KAAK,GAAG,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;IACjC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,EAAE,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,aAAa,CAAC,WAAW,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QACnC,UAAU,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,aAAa,CAAC,CAAC,GAAG,UAAU,CAAC;IAC3E,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,UAAU,CAAC,iBAAiB,aAAa,yBAAyB,CAAC,iCAAiC,CAAC,CAAC;IACpH,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,UAAU,CAAC,YAAY,QAAQ,wCAAwC,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAC9B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,EAAE,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC;IAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACzB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChB,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,KAAK,CAAC;QACnE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAChB,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAChB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAC7B,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;AAC/F,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAAC,IAAoB,EAAE,KAAa,EAAE,GAAW,EAAE,GAAe;IAC5F,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACpE,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;IAC5D,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChB,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAClG,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;gBACpB,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;oBAChB,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACnB,CAAC;gBACD,SAAS;YACb,CAAC;YACD,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YAC7B,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACxE,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACnB,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,eAAe,CAAC,OAA0B;IACtD,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClF,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACrC,OAAO,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;AAC7G,CAAC"}

package/dist/src/generators/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * `@graphty/graph-samples/generators`: every graph generator. Each returns a {@link SampleGraph}
+ * (typed arrays that `fromEdgeArrays` of @graphty/graph-format loads directly). The random ones
+ * take an optional `seed` (default 0) and produce the same graph for the same options on every platform and
+ * every version of this package.
+ */
+export { type SampleGraph } from "../types.js";
+export { randomBipartiteGraph, type RandomBipartiteOptions } from "./bipartite.js";
+export { plantedPartitionGraph, type PlantedPartitionOptions, stochasticBlockModelGraph, type StochasticBlockModelOptions, } from "./block-model.js";
+export { balancedTreeGraph, barbellGraph, cavemanGraph, circularLadderGraph, completeBipartiteGraph, completeGraph, completeMultipartiteGraph, connectedCavemanGraph, cycleGraph, emptyGraph, hypercubeGraph, ladderGraph, lollipopGraph, mobiusLadderGraph, pathGraph, petersenGraph, ringOfCliquesGraph, starGraph, wheelGraph, } from "./classic.js";
+export { bipartiteConfigurationModelGraph, type BipartiteConfigurationModelOptions, chungLuGraph, type ChungLuOptions, configurationModelGraph, type ConfigurationModelOptions, degreeCorrectedSbmGraph, type DegreeCorrectedSbmOptions, directedConfigurationModelGraph, type DirectedConfigurationModelOptions, type EdgePolicy, powerLawDegreeSequence, type PowerLawDegreeSequenceOptions, randomRegularGraph, type RandomRegularOptions, } from "./degree-sequence.js";
+export { kroneckerGraph, type KroneckerOptions, priceGraph, type PriceOptions, randomOrderDagGraph, type RandomOrderDagOptions, rmatGraph, type RmatOptions, } from "./directed.js";
+export { erdosRenyiGnmGraph, type ErdosRenyiGnmOptions, erdosRenyiGraph, type ErdosRenyiOptions, } from "./erdos-renyi.js";
+export { akGraph, type AkOptions, type FlowNetwork, genrmfGraph, type GenrmfOptions, gridFlowNetwork, type GridFlowOptions, layeredFlowNetwork, type LayeredFlowOptions, } from "./flow.js";
+export { knnGraph, type KnnOptions, randomGeometricGraph, type RandomGeometricOptions, waxmanGraph, type WaxmanOptions, } from "./geometric.js";
+export { bianconiBarabasiGraph, type BianconiBarabasiOptions, duplicationDivergenceGraph, type DuplicationDivergenceOptions, forestFireGraph, type ForestFireOptions, newmanWattsGraph, type NewmanWattsOptions, randomApollonianGraph, type RandomApollonianOptions, randomRecursiveTreeGraph, type RandomRecursiveTreeOptions, wilsonMazeGraph, type WilsonMazeOptions, } from "./growth.js";
+export { hyperbolicGraph, type HyperbolicOptions } from "./hyperbolic.js";
+export { grid3dGraph, type Grid3dOptions, gridGraph, type GridOptions, hexagonalLatticeGraph, type PlanarLatticeOptions, triangularLatticeGraph, } from "./lattices.js";
+export { lfrGraph, type LfrOptions } from "./lfr.js";
+export { NAMED_GRAPH_NAMES, namedGraph, type NamedGraphName } from "./named.js";
+export { barabasiAlbertGraph, type BarabasiAlbertOptions, wattsStrogatzGraph, type WattsStrogatzOptions, } from "./preferential-attachment.js";
+export { randomDagGraph, type RandomDagOptions, randomTreeGraph, type RandomTreeOptions } from "./trees-and-dags.js";
+export { addPathologicalEdges, EDGE_CASE_NAMES, edgeCaseGraph, type EdgeCaseName, type PathologicalEdgeOptions, randomMultigraph, type RandomMultigraphOptions, } from "./variants.js";
+export { type ColumnCombine, type WeightOptions, type WeightSpec, withWeights } from "./weights.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/generators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/generators/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EACH,qBAAqB,EACrB,KAAK,uBAAuB,EAC5B,yBAAyB,EACzB,KAAK,2BAA2B,GACnC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,EACb,yBAAyB,EACzB,qBAAqB,EACrB,UAAU,EACV,UAAU,EACV,cAAc,EACd,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,UAAU,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACH,gCAAgC,EAChC,KAAK,kCAAkC,EACvC,YAAY,EACZ,KAAK,cAAc,EACnB,uBAAuB,EACvB,KAAK,yBAAyB,EAC9B,uBAAuB,EACvB,KAAK,yBAAyB,EAC9B,+BAA+B,EAC/B,KAAK,iCAAiC,EACtC,KAAK,UAAU,EACf,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,kBAAkB,EAClB,KAAK,oBAAoB,GAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,cAAc,EACd,KAAK,gBAAgB,EACrB,UAAU,EACV,KAAK,YAAY,EACjB,mBAAmB,EACnB,KAAK,qBAAqB,EAC1B,SAAS,EACT,KAAK,WAAW,GACnB,MAAM,eAAe,CAAC;AACvB,OAAO,EACH,kBAAkB,EAClB,KAAK,oBAAoB,EACzB,eAAe,EACf,KAAK,iBAAiB,GACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,OAAO,EACP,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,WAAW,EACX,KAAK,aAAa,EAClB,eAAe,EACf,KAAK,eAAe,EACpB,kBAAkB,EAClB,KAAK,kBAAkB,GAC1B,MAAM,WAAW,CAAC;AACnB,OAAO,EACH,QAAQ,EACR,KAAK,UAAU,EACf,oBAAoB,EACpB,KAAK,sBAAsB,EAC3B,WAAW,EACX,KAAK,aAAa,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACH,qBAAqB,EACrB,KAAK,uBAAuB,EAC5B,0BAA0B,EAC1B,KAAK,4BAA4B,EACjC,eAAe,EACf,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,KAAK,kBAAkB,EACvB,qBAAqB,EACrB,KAAK,uBAAuB,EAC5B,wBAAwB,EACxB,KAAK,0BAA0B,EAC/B,eAAe,EACf,KAAK,iBAAiB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,eAAe,EAAE,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EACH,WAAW,EACX,KAAK,aAAa,EAClB,SAAS,EACT,KAAK,WAAW,EAChB,qBAAqB,EACrB,KAAK,oBAAoB,EACzB,sBAAsB,GACzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAChF,OAAO,EACH,mBAAmB,EACnB,KAAK,qBAAqB,EAC1B,kBAAkB,EAClB,KAAK,oBAAoB,GAC5B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,KAAK,gBAAgB,EAAE,eAAe,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACrH,OAAO,EACH,oBAAoB,EACpB,eAAe,EACf,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,uBAAuB,EAC5B,gBAAgB,EAChB,KAAK,uBAAuB,GAC/B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}

package/dist/src/generators/index.js

@@ -0,0 +1,24 @@
+/**
+ * `@graphty/graph-samples/generators`: every graph generator. Each returns a {@link SampleGraph}
+ * (typed arrays that `fromEdgeArrays` of @graphty/graph-format loads directly). The random ones
+ * take an optional `seed` (default 0) and produce the same graph for the same options on every platform and
+ * every version of this package.
+ */
+export { randomBipartiteGraph } from "./bipartite.js";
+export { plantedPartitionGraph, stochasticBlockModelGraph, } from "./block-model.js";
+export { balancedTreeGraph, barbellGraph, cavemanGraph, circularLadderGraph, completeBipartiteGraph, completeGraph, completeMultipartiteGraph, connectedCavemanGraph, cycleGraph, emptyGraph, hypercubeGraph, ladderGraph, lollipopGraph, mobiusLadderGraph, pathGraph, petersenGraph, ringOfCliquesGraph, starGraph, wheelGraph, } from "./classic.js";
+export { bipartiteConfigurationModelGraph, chungLuGraph, configurationModelGraph, degreeCorrectedSbmGraph, directedConfigurationModelGraph, powerLawDegreeSequence, randomRegularGraph, } from "./degree-sequence.js";
+export { kroneckerGraph, priceGraph, randomOrderDagGraph, rmatGraph, } from "./directed.js";
+export { erdosRenyiGnmGraph, erdosRenyiGraph, } from "./erdos-renyi.js";
+export { akGraph, genrmfGraph, gridFlowNetwork, layeredFlowNetwork, } from "./flow.js";
+export { knnGraph, randomGeometricGraph, waxmanGraph, } from "./geometric.js";
+export { bianconiBarabasiGraph, duplicationDivergenceGraph, forestFireGraph, newmanWattsGraph, randomApollonianGraph, randomRecursiveTreeGraph, wilsonMazeGraph, } from "./growth.js";
+export { hyperbolicGraph } from "./hyperbolic.js";
+export { grid3dGraph, gridGraph, hexagonalLatticeGraph, triangularLatticeGraph, } from "./lattices.js";
+export { lfrGraph } from "./lfr.js";
+export { NAMED_GRAPH_NAMES, namedGraph } from "./named.js";
+export { barabasiAlbertGraph, wattsStrogatzGraph, } from "./preferential-attachment.js";
+export { randomDagGraph, randomTreeGraph } from "./trees-and-dags.js";
+export { addPathologicalEdges, EDGE_CASE_NAMES, edgeCaseGraph, randomMultigraph, } from "./variants.js";
+export { withWeights } from "./weights.js";
+//# sourceMappingURL=index.js.map

package/dist/src/generators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generators/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,oBAAoB,EAA+B,MAAM,gBAAgB,CAAC;AACnF,OAAO,EACH,qBAAqB,EAErB,yBAAyB,GAE5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,EACb,yBAAyB,EACzB,qBAAqB,EACrB,UAAU,EACV,UAAU,EACV,cAAc,EACd,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,UAAU,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACH,gCAAgC,EAEhC,YAAY,EAEZ,uBAAuB,EAEvB,uBAAuB,EAEvB,+BAA+B,EAG/B,sBAAsB,EAEtB,kBAAkB,GAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACH,cAAc,EAEd,UAAU,EAEV,mBAAmB,EAEnB,SAAS,GAEZ,MAAM,eAAe,CAAC;AACvB,OAAO,EACH,kBAAkB,EAElB,eAAe,GAElB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,OAAO,EAGP,WAAW,EAEX,eAAe,EAEf,kBAAkB,GAErB,MAAM,WAAW,CAAC;AACnB,OAAO,EACH,QAAQ,EAER,oBAAoB,EAEpB,WAAW,GAEd,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACH,qBAAqB,EAErB,0BAA0B,EAE1B,eAAe,EAEf,gBAAgB,EAEhB,qBAAqB,EAErB,wBAAwB,EAExB,eAAe,GAElB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,eAAe,EAA0B,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EACH,WAAW,EAEX,SAAS,EAET,qBAAqB,EAErB,sBAAsB,GACzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAmB,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAuB,MAAM,YAAY,CAAC;AAChF,OAAO,EACH,mBAAmB,EAEnB,kBAAkB,GAErB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAyB,eAAe,EAA0B,MAAM,qBAAqB,CAAC;AACrH,OAAO,EACH,oBAAoB,EACpB,eAAe,EACf,aAAa,EAGb,gBAAgB,GAEnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAA2D,WAAW,EAAE,MAAM,cAAc,CAAC"}

package/dist/src/generators/lattices.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Lattices: the square and cubic grids (with torus wrap-around, diagonal neighbours, forward-only
+ * arcs, random obstacles and position columns), the triangular lattice and the hexagonal
+ * (honeycomb) lattice. All deterministic except the obstacles, which draw from stream
+ * (seed, "grid-obstacles", node).
+ */
+import { type SampleGraph } from "../types.js";
+import { type WeightOptions } from "./weights.js";
+/** Options of {@link grid3dGraph}. */
+export interface Grid3dOptions extends WeightOptions {
+    /** The number of rows, >= 1. */
+    rows: number;
+    /** The number of columns, >= 1. */
+    cols: number;
+    /** The number of layers, >= 1. */
+    layers: number;
+    /**
+     * Wrap around (a torus): the last node of each row, column and layer is joined to the first.
+     * A dimension shorter than 3 does not wrap, so the graph stays simple.
+     */
+    periodic?: boolean | undefined;
+    /**
+     * Join diagonal neighbours too: the king's graph (8 neighbours) in 2D, the 26-neighbour lattice
+     * in 3D.
+     */
+    diagonals?: boolean | undefined;
+    /**
+     * Emit each edge once as an arc from the lower index to the higher: a DAG whose only source is
+     * node 0 and only sink node n - 1. Not with `periodic`.
+     */
+    directed?: boolean | undefined;
+    /**
+     * Block each node independently with this probability, in [0, 1): a blocked node keeps its
+     * index (and position) but has no edges, and the u8 node column `blocked` marks it (1).
+     */
+    obstacles?: number | undefined;
+    /** Emit Float64 node columns `x` (column), `y` (row) and, when layers > 1, `z` (layer). */
+    positions?: boolean | undefined;
+}
+/** Options of {@link gridGraph}: {@link Grid3dOptions} without layers. */
+export type GridOptions = Omit<Grid3dOptions, "layers">;
+/**
+ * The rows x cols x layers grid. Node (l, r, c) is index (l * rows + r) * cols + c. For each node
+ * in index order, the edge to each forward neighbour in the order of the offsets: +column, +row,
+ * +layer, then the diagonals. Without options this is the 6-neighbour lattice of phase 1, edge for
+ * edge. Obstacles draw one float per node from stream (seed, "grid-obstacles", node) -- node < p
+ * blocks it -- so the obstacle map does not depend on the other options.
+ * @param options - sizes and the lattice options
+ * @returns the graph
+ */
+export declare function grid3dGraph(options: Grid3dOptions): SampleGraph;
+/**
+ * The rows x cols grid: {@link grid3dGraph} with one layer. Node (r, c) is index r * cols + c; for
+ * each node in index order, the edge to its right neighbour, then the one below, then (with
+ * diagonals) below-left and below-right.
+ * @param options - sizes and the lattice options
+ * @returns the graph
+ */
+export declare function gridGraph(options: GridOptions): SampleGraph;
+/** Options of {@link triangularLatticeGraph} and {@link hexagonalLatticeGraph}. */
+export interface PlanarLatticeOptions extends WeightOptions {
+    /** The number of rows, >= 1. */
+    rows: number;
+    /** The number of columns, >= 1. */
+    cols: number;
+    /** Emit Float64 node columns `x` and `y` placing every edge at unit length. */
+    positions?: boolean | undefined;
+}
+/**
+ * The triangular lattice as a triangulated rows x cols grid: node (r, c) is index r * cols + c and
+ * links to (r, c + 1), (r + 1, c) and (r + 1, c - 1), in that order, for each node in index order.
+ * Interior nodes have degree 6. Positions shear the grid into a parallelogram of equilateral
+ * triangles: x = c + r / 2, y = r sqrt(3) / 2.
+ * @param options - rows, cols, positions
+ * @returns the undirected graph
+ */
+export declare function triangularLatticeGraph(options: PlanarLatticeOptions): SampleGraph;
+/**
+ * The hexagonal (honeycomb) lattice in its brick-wall form: node (r, c) is index r * cols + c and
+ * links to (r, c + 1) always and to (r + 1, c) when r + c is even, in that order, for each node in
+ * index order. Interior nodes have degree 3; every face is a hexagon. Positions give unit edges:
+ * x = c sqrt(3) / 2, y = 1.5 r + (r + c even ? 0.5 : 0).
+ * @param options - rows, cols, positions
+ * @returns the undirected graph
+ */
+export declare function hexagonalLatticeGraph(options: PlanarLatticeOptions): SampleGraph;
+//# sourceMappingURL=lattices.d.ts.map

package/dist/src/generators/lattices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lattices.d.ts","sourceRoot":"","sources":["../../../src/generators/lattices.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAEhE,sCAAsC;AACtC,MAAM,WAAW,aAAc,SAAQ,aAAa;IAChD,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,2FAA2F;IAC3F,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACnC;AAED,0EAA0E;AAC1E,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AA+BxD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,WAAW,CAyF/D;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,WAAW,CAE3D;AAED,mFAAmF;AACnF,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACvD,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,+EAA+E;IAC/E,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACnC;AAkBD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,oBAAoB,GAAG,WAAW,CA8BjF;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,oBAAoB,GAAG,WAAW,CA4BhF"}

package/dist/src/generators/lattices.js

@@ -0,0 +1,237 @@
+/**
+ * Lattices: the square and cubic grids (with torus wrap-around, diagonal neighbours, forward-only
+ * arcs, random obstacles and position columns), the triangular lattice and the hexagonal
+ * (honeycomb) lattice. All deterministic except the obstacles, which draw from stream
+ * (seed, "grid-obstacles", node).
+ */
+import { RandomStream, resolveSeed } from "../random/stream.js";
+import { checkEdgeCount, checkInt, checkProbability, EdgeBuffer, toGraph } from "./util.js";
+import { applyWeights } from "./weights.js";
+/**
+ * The neighbour offsets (dc, dr, dl) a node links forward to, in edge order: +column, +row,
+ * +layer, then (with diagonals) every other offset in {-1, 0, 1}^3 that is lexicographically
+ * positive in (dl, dr, dc), ordered by dl, then dr, then dc.
+ * @param diagonals - whether to include the diagonal offsets
+ * @returns the offsets
+ */
+function forwardOffsets(diagonals) {
+    const offsets = [
+        [1, 0, 0],
+        [0, 1, 0],
+        [0, 0, 1],
+    ];
+    if (diagonals) {
+        for (let dl = 0; dl <= 1; dl++) {
+            for (let dr = -1; dr <= 1; dr++) {
+                for (let dc = -1; dc <= 1; dc++) {
+                    const positive = dl > 0 || (dl === 0 && (dr > 0 || (dr === 0 && dc > 0)));
+                    const axis = Math.abs(dc) + Math.abs(dr) + Math.abs(dl) === 1;
+                    if (positive && !axis) {
+                        offsets.push([dc, dr, dl]);
+                    }
+                }
+            }
+        }
+    }
+    return offsets;
+}
+/**
+ * The rows x cols x layers grid. Node (l, r, c) is index (l * rows + r) * cols + c. For each node
+ * in index order, the edge to each forward neighbour in the order of the offsets: +column, +row,
+ * +layer, then the diagonals. Without options this is the 6-neighbour lattice of phase 1, edge for
+ * edge. Obstacles draw one float per node from stream (seed, "grid-obstacles", node) -- node < p
+ * blocks it -- so the obstacle map does not depend on the other options.
+ * @param options - sizes and the lattice options
+ * @returns the graph
+ */
+export function grid3dGraph(options) {
+    const { rows, cols, layers } = options;
+    checkInt("rows", rows, 1);
+    checkInt("cols", cols, 1);
+    checkInt("layers", layers, 1);
+    const n = rows * cols * layers;
+    checkInt("rows * cols * layers", n, 1);
+    const periodic = options.periodic === true;
+    const directed = options.directed === true;
+    if (periodic && directed) {
+        throw new RangeError("directed grids cannot be periodic: the wrap-around arcs would close cycles");
+    }
+    const offsets = forwardOffsets(options.diagonals === true);
+    checkEdgeCount(n * offsets.length);
+    let blocked = null;
+    if (options.obstacles !== undefined) {
+        const p = options.obstacles;
+        checkProbability("obstacles", p);
+        if (p >= 1) {
+            throw new RangeError("obstacles must be below 1");
+        }
+        blocked = new Uint8Array(n);
+        const stream = new RandomStream(resolveSeed(options.seed), "grid-obstacles", 0);
+        for (let i = 0; i < n; i++) {
+            stream.reset(i);
+            blocked[i] = stream.nextFloat() < p ? 1 : 0;
+        }
+    }
+    const sizes = [cols, rows, layers];
+    const wraps = sizes.map((size) => periodic && size >= 3);
+    const plane = rows * cols;
+    const out = new EdgeBuffer(n * Math.min(offsets.length, 3));
+    const at = [0, 0, 0];
+    for (let l = 0; l < layers; l++) {
+        for (let r = 0; r < rows; r++) {
+            for (let c = 0; c < cols; c++) {
+                const i = l * plane + r * cols + c;
+                if (blocked?.[i] === 1) {
+                    continue;
+                }
+                const here = [c, r, l];
+                for (const offset of offsets) {
+                    let inside = true;
+                    for (let axis = 0; axis < 3; axis++) {
+                        let x = here[axis] + offset[axis];
+                        if (x < 0 || x >= sizes[axis]) {
+                            if (!wraps[axis]) {
+                                inside = false;
+                                break;
+                            }
+                            x = (x + sizes[axis]) % sizes[axis];
+                        }
+                        at[axis] = x;
+                    }
+                    if (!inside) {
+                        continue;
+                    }
+                    const j = at[2] * plane + at[1] * cols + at[0];
+                    if (blocked?.[j] === 1) {
+                        continue;
+                    }
+                    out.push(directed && j < i ? j : i, directed && j < i ? i : j);
+                }
+            }
+        }
+    }
+    const columns = {};
+    if (blocked !== null) {
+        columns.blocked = blocked;
+    }
+    if (options.positions === true) {
+        const x = new Float64Array(n);
+        const y = new Float64Array(n);
+        const z = layers > 1 ? new Float64Array(n) : null;
+        for (let i = 0; i < n; i++) {
+            x[i] = i % cols;
+            y[i] = Math.floor(i / cols) % rows;
+            if (z !== null) {
+                z[i] = Math.floor(i / plane);
+            }
+        }
+        columns.x = x;
+        columns.y = y;
+        if (z !== null) {
+            columns.z = z;
+        }
+    }
+    const graph = toGraph(n, out, directed, Object.keys(columns).length > 0 ? columns : undefined);
+    return applyWeights(graph, options);
+}
+/**
+ * The rows x cols grid: {@link grid3dGraph} with one layer. Node (r, c) is index r * cols + c; for
+ * each node in index order, the edge to its right neighbour, then the one below, then (with
+ * diagonals) below-left and below-right.
+ * @param options - sizes and the lattice options
+ * @returns the graph
+ */
+export function gridGraph(options) {
+    return grid3dGraph({ ...options, layers: 1 });
+}
+const HALF_SQRT3 = 0.8660254037844386;
+/**
+ * Check the sizes of a planar lattice.
+ * @param options - the options
+ * @returns the node count
+ */
+function planarSize(options) {
+    checkInt("rows", options.rows, 1);
+    checkInt("cols", options.cols, 1);
+    const n = options.rows * options.cols;
+    checkInt("rows * cols", n, 1);
+    checkEdgeCount(3 * n);
+    return n;
+}
+/**
+ * The triangular lattice as a triangulated rows x cols grid: node (r, c) is index r * cols + c and
+ * links to (r, c + 1), (r + 1, c) and (r + 1, c - 1), in that order, for each node in index order.
+ * Interior nodes have degree 6. Positions shear the grid into a parallelogram of equilateral
+ * triangles: x = c + r / 2, y = r sqrt(3) / 2.
+ * @param options - rows, cols, positions
+ * @returns the undirected graph
+ */
+export function triangularLatticeGraph(options) {
+    const n = planarSize(options);
+    const { rows, cols } = options;
+    const out = new EdgeBuffer(3 * n);
+    for (let r = 0; r < rows; r++) {
+        for (let c = 0; c < cols; c++) {
+            const i = r * cols + c;
+            if (c + 1 < cols) {
+                out.push(i, i + 1);
+            }
+            if (r + 1 < rows) {
+                out.push(i, i + cols);
+                if (c > 0) {
+                    out.push(i, i + cols - 1);
+                }
+            }
+        }
+    }
+    let columns;
+    if (options.positions === true) {
+        const x = new Float64Array(n);
+        const y = new Float64Array(n);
+        for (let i = 0; i < n; i++) {
+            const r = Math.floor(i / cols);
+            x[i] = (i % cols) + r / 2;
+            y[i] = r * HALF_SQRT3;
+        }
+        columns = { x, y };
+    }
+    return applyWeights(toGraph(n, out, false, columns), options);
+}
+/**
+ * The hexagonal (honeycomb) lattice in its brick-wall form: node (r, c) is index r * cols + c and
+ * links to (r, c + 1) always and to (r + 1, c) when r + c is even, in that order, for each node in
+ * index order. Interior nodes have degree 3; every face is a hexagon. Positions give unit edges:
+ * x = c sqrt(3) / 2, y = 1.5 r + (r + c even ? 0.5 : 0).
+ * @param options - rows, cols, positions
+ * @returns the undirected graph
+ */
+export function hexagonalLatticeGraph(options) {
+    const n = planarSize(options);
+    const { rows, cols } = options;
+    const out = new EdgeBuffer(2 * n);
+    for (let r = 0; r < rows; r++) {
+        for (let c = 0; c < cols; c++) {
+            const i = r * cols + c;
+            if (c + 1 < cols) {
+                out.push(i, i + 1);
+            }
+            if (r + 1 < rows && (r + c) % 2 === 0) {
+                out.push(i, i + cols);
+            }
+        }
+    }
+    let columns;
+    if (options.positions === true) {
+        const x = new Float64Array(n);
+        const y = new Float64Array(n);
+        for (let i = 0; i < n; i++) {
+            const r = Math.floor(i / cols);
+            const c = i % cols;
+            x[i] = c * HALF_SQRT3;
+            y[i] = 1.5 * r + ((r + c) % 2 === 0 ? 0.5 : 0);
+        }
+        columns = { x, y };
+    }
+    return applyWeights(toGraph(n, out, false, columns), options);
+}
+//# sourceMappingURL=lattices.js.map

package/dist/src/generators/lattices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lattices.js","sourceRoot":"","sources":["../../../src/generators/lattices.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,gBAAgB,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAsB,MAAM,cAAc,CAAC;AAqChE;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,SAAkB;IACtC,MAAM,OAAO,GAAG;QACZ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;KACZ,CAAC;IACF,IAAI,SAAS,EAAE,CAAC;QACZ,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;YAC7B,KAAK,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;gBAC9B,KAAK,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;oBAC9B,MAAM,QAAQ,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;oBAC9D,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;wBACpB,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC/B,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,OAAsB;IAC9C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC9B,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;IAC/B,QAAQ,CAAC,sBAAsB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC;IAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC;IAC3C,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAAC;QACvB,MAAM,IAAI,UAAU,CAAC,4EAA4E,CAAC,CAAC;IACvG,CAAC;IACD,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;IAC3D,cAAc,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,OAAO,GAAmC,IAAI,CAAC;IACnD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;QAC5B,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACT,MAAM,IAAI,UAAU,CAAC,2BAA2B,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;QAChF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChB,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;IACL,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1B,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;gBACnC,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,SAAS;gBACb,CAAC;gBACD,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;oBAC3B,IAAI,MAAM,GAAG,IAAI,CAAC;oBAClB,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC;wBAClC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;wBAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;4BAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gCACf,MAAM,GAAG,KAAK,CAAC;gCACf,MAAM;4BACV,CAAC;4BACD,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;wBACxC,CAAC;wBACD,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACjB,CAAC;oBACD,IAAI,CAAC,MAAM,EAAE,CAAC;wBACV,SAAS;oBACb,CAAC;oBACD,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC/C,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;wBACrB,SAAS;oBACb,CAAC;oBACD,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,OAAO,GAAwE,EAAE,CAAC;IACxF,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAC9B,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;YAChB,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;YACnC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBACb,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;YACjC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;QACd,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACb,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;IACL,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/F,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,OAAoB;IAC1C,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;AAClD,CAAC;AAYD,MAAM,UAAU,GAAG,kBAAkB,CAAC;AAEtC;;;;GAIG;AACH,SAAS,UAAU,CAAC,OAA6B;IAC7C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAClC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACtB,OAAO,CAAC,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA6B;IAChE,MAAM,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAC/B,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC;gBACf,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACvB,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC;gBACf,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;gBACtB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACR,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;gBAC9B,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,OAAmC,CAAC;IACxC,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;QAC1B,CAAC;QACD,OAAO,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACvB,CAAC;IACD,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAA6B;IAC/D,MAAM,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAC/B,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC;gBACf,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACvB,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1B,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,OAAmC,CAAC;IACxC,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;YAC/B,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;YACnB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;YACtB,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IACvB,CAAC;IACD,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC"}

package/dist/src/generators/lfr.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The LFR community-detection benchmark: power-law degrees, power-law community sizes and a
+ * mixing parameter, with the planted communities as ground truth.
+ */
+import { type SampleGraph } from "../types.js";
+import { type WeightOptions } from "./weights.js";
+/** Options of {@link lfrGraph}. */
+export interface LfrOptions extends WeightOptions {
+    /** The node count, in [1, 1,000,000]. */
+    n: number;
+    /** The smallest degree, >= 1. */
+    minDegree: number;
+    /** The largest degree, in [minDegree, n - 1]. */
+    maxDegree: number;
+    /** The degree power-law exponent (tau1), a finite number >= 0, typically 2 to 3. */
+    degreeExponent: number;
+    /** The smallest community, >= 1. */
+    minCommunity: number;
+    /** The largest community, in [minCommunity, n]. */
+    maxCommunity: number;
+    /** The community-size power-law exponent (tau2), a finite number >= 0, typically 1 to 2. */
+    communityExponent: number;
+    /** The mixing parameter mu in [0, 1]: the share of each node's edges that leave its community. */
+    mixing: number;
+    /** The seed, an integer in [0, 2^53); default 0. */
+    seed?: number | undefined;
+}
+/**
+ * The LFR benchmark (A. Lancichinetti, S. Fortunato and F. Radicchi, "Benchmark graphs for testing
+ * community detection algorithms", Phys. Rev. E 78, 046110, 2008,
+ * doi:10.1103/PhysRevE.78.046110), built with configuration models:
+ *
+ * 1. Degrees: node i's degree is the i-th power-law draw on [minDegree, maxDegree] from stream
+ *    (seed, "lfr-degrees", 0); an odd sum is fixed on the last node as in powerLawDegreeSequence.
+ * 2. Community sizes: power law on [minCommunity, maxCommunity] summing to exactly n (stream
+ *    "lfr-sizes"); community ids are the draw order.
+ * 3. Internal degree round((1 - mu) d); assignment of nodes to communities larger than their
+ *    internal degree (stream "lfr-assign"); a RangeError when none exists.
+ * 4. Inside each community c, ascending: when its internal degrees sum to an odd number the member
+ *    with the largest (lowest index on ties) moves one stub to the outside; then a configuration
+ *    model on the members' ascending stub list shuffled with stream (seed, "lfr-internal", c).
+ * 5. Outside: a configuration model on the remaining degrees d - internal, stream
+ *    (seed, "lfr-external", 0).
+ *
+ * Self-loops and repeated pairs are erased, and so are external pairs that land inside one
+ * community, so degrees and the mixing come out approximate: the mean degree drops by up to about
+ * 10% (repeated pairs inside small communities), and the measured mixing lands within about 0.02 of
+ * mu for thousands of nodes. No edge switching repairs this. Edges: every community's internal
+ * edges (communities ascending, pair order), then the external edges. Node column `community` (u32).
+ * O(n log n + m); n at most 1,000,000.
+ * @param options - n, degree and community power laws, mixing and seed
+ * @returns the undirected graph
+ */
+export declare function lfrGraph(options: LfrOptions): SampleGraph;
+//# sourceMappingURL=lfr.d.ts.map

package/dist/src/generators/lfr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lfr.d.ts","sourceRoot":"","sources":["../../../src/generators/lfr.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAKhE,mCAAmC;AACnC,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC7C,yCAAyC;IACzC,CAAC,EAAE,MAAM,CAAC;IACV,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,oFAAoF;IACpF,cAAc,EAAE,MAAM,CAAC;IACvB,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB,4FAA4F;IAC5F,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kGAAkG;IAClG,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAqFD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,UAAU,GAAG,WAAW,CAiFzD"}