hullabaloo 0.1.0

Backend-agnostic geometry construction utilities.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
use ahash::AHashMap;
use smallvec::SmallVec;

use crate::error::{HullabalooError, HullabalooResult};
use crate::graph::Graph;
use crate::set_family::{SetFamily, SetFamilyBuilder};
use crate::types::RowId;

type Key = SmallVec<[usize; 16]>;

/// A sink for building an undirected adjacency structure.
///
/// This is generic so the core FR/adjacency algorithm can write into either an edge-list style
/// adjacency (`Graph`) or a bitset-based adjacency (e.g. `howzat::SetFamily`) without paying for
/// conversions.
pub trait AdjacencyBuilder {
    type Output;

    fn new(node_count: usize) -> Self;
    fn add_undirected_edge(&mut self, a: usize, b: usize);
    fn finish(self) -> Self::Output;
}

impl AdjacencyBuilder for Graph {
    type Output = Graph;

    #[inline]
    fn new(node_count: usize) -> Self {
        Self {
            adjacency: vec![Vec::new(); node_count],
        }
    }

    #[inline]
    fn add_undirected_edge(&mut self, a: usize, b: usize) {
        self.adjacency[a].push(b);
        self.adjacency[b].push(a);
    }

    #[inline]
    fn finish(mut self) -> Self::Output {
        for neigh in &mut self.adjacency {
            neigh.sort_unstable();
            neigh.dedup();
        }
        self
    }
}

impl AdjacencyBuilder for SetFamilyBuilder {
    type Output = SetFamily;

    #[inline]
    fn new(node_count: usize) -> Self {
        SetFamily::builder(node_count, node_count)
    }

    #[inline]
    fn add_undirected_edge(&mut self, a: usize, b: usize) {
        self.insert_into_set(a, RowId::new(b));
        self.insert_into_set(b, RowId::new(a));
    }

    #[inline]
    fn finish(self) -> Self::Output {
        self.build()
    }
}

#[derive(Clone, Debug)]
struct SparseRowMembershipIndex {
    row_offsets: Vec<usize>,
    members: Vec<usize>,
}

impl SparseRowMembershipIndex {
    fn new<R: AsRef<[usize]>>(rows_by_node: &[R], row_capacity: usize) -> Self {
        let mut degrees: Vec<usize> = vec![0; row_capacity];
        for rows in rows_by_node {
            for &row in rows.as_ref() {
                if row < row_capacity {
                    degrees[row] = degrees[row].saturating_add(1);
                }
            }
        }

        let mut row_offsets: Vec<usize> = vec![0; row_capacity.saturating_add(1)];
        for row in 0..row_capacity {
            row_offsets[row + 1] = row_offsets[row].saturating_add(degrees[row]);
        }

        let mut members: Vec<usize> = vec![0; row_offsets[row_capacity]];
        let mut cursor = row_offsets.clone();
        for (node, rows) in rows_by_node.iter().enumerate() {
            for &row in rows.as_ref() {
                if row >= row_capacity {
                    continue;
                }
                let pos = cursor[row];
                if pos < members.len() {
                    members[pos] = node;
                    cursor[row] = pos + 1;
                }
            }
        }

        Self {
            row_offsets,
            members,
        }
    }

    #[inline]
    fn members_of_row(&self, row: usize) -> &[usize] {
        let Some((&start, &end)) = self
            .row_offsets
            .get(row)
            .zip(self.row_offsets.get(row.saturating_add(1)))
        else {
            return &[];
        };
        self.members.get(start..end).unwrap_or(&[])
    }

    #[inline]
    fn row_contains_node(&self, row: usize, node: usize) -> bool {
        self.members_of_row(row).binary_search(&node).is_ok()
    }
}

#[inline]
fn intersect_sorted_rows(a: &[usize], b: &[usize], out: &mut Vec<usize>) {
    out.clear();
    let mut i = 0usize;
    let mut j = 0usize;
    while i < a.len() && j < b.len() {
        match a[i].cmp(&b[j]) {
            std::cmp::Ordering::Less => i += 1,
            std::cmp::Ordering::Greater => j += 1,
            std::cmp::Ordering::Equal => {
                out.push(a[i]);
                i += 1;
                j += 1;
            }
        }
    }
}

fn has_third_node_containing_face(
    membership: &SparseRowMembershipIndex,
    face_rows: &[usize],
    node_a: usize,
    node_b: usize,
    non_excluded_nodes: usize,
) -> bool {
    if face_rows.is_empty() {
        // The empty face is contained in every node; only adjacent when no third node exists.
        return non_excluded_nodes > 2;
    }

    let mut base_row = face_rows[0];
    let mut base_len = membership.members_of_row(base_row).len();
    for &row in face_rows.iter().skip(1) {
        let len = membership.members_of_row(row).len();
        if len < base_len {
            base_row = row;
            base_len = len;
            if base_len <= 2 {
                break;
            }
        }
    }

    for &candidate in membership.members_of_row(base_row) {
        if candidate == node_a || candidate == node_b {
            continue;
        }
        let mut ok = true;
        for &row in face_rows {
            if row == base_row {
                continue;
            }
            if !membership.row_contains_node(row, candidate) {
                ok = false;
                break;
            }
        }
        if ok {
            return true;
        }
    }
    false
}

/// Options for building an adjacency graph from incidence sets.
#[derive(Clone, Copy, Debug, Default)]
pub struct IncidenceAdjacencyOptions<'a> {
    /// Nodes to exclude from adjacency computation (e.g. linearity generators).
    ///
    /// When `None`, all nodes are considered active.
    pub excluded_nodes: Option<&'a [bool]>,

    /// Active universe rows; rows with `false` are ignored.
    ///
    /// When `None`, all rows are active.
    pub active_rows: Option<&'a [bool]>,

    /// Candidate edges to test (pairs of node indices). When `None`, the builder enumerates
    /// candidate edges using the sparse membership index.
    pub candidate_edges: Option<&'a [(usize, usize)]>,

    /// If `true`, skip degeneracy containment checks.
    pub assume_nondegenerate: bool,
}

/// Options for building adjacency from pre-filtered per-node incidence rows.
#[derive(Clone, Copy, Debug, Default)]
pub struct RowsByNodeAdjacencyOptions<'a> {
    /// Nodes to exclude from adjacency computation (e.g. linearity generators).
    ///
    /// When `None`, all nodes are considered active.
    pub excluded_nodes: Option<&'a [bool]>,

    /// Candidate edges to test (pairs of node indices). When `None`, the builder enumerates
    /// candidate edges using the sparse membership index.
    pub candidate_edges: Option<&'a [(usize, usize)]>,

    /// If `true`, skip degeneracy containment checks.
    pub assume_nondegenerate: bool,
}

/// Build an undirected adjacency graph from a family of incidence sets.
///
/// The criterion matches the "ridge adjacency" / "dual graph" logic:
/// - Let `face = S[i] ∩ S[j]` (restricted to `active_rows`).
/// - Require `|face| >= adj_dim - 2`.
/// - In degenerate mode, reject `(i,j)` if there exists any third node `k` whose set contains `face`.
///
/// `adj_dim` should be the dimension of the homogenized cone / system (typically `d+1` for polytopes).
pub fn adjacency_from_incidence(
    sets: &[Vec<usize>],
    universe_size: usize,
    adj_dim: usize,
    options: IncidenceAdjacencyOptions<'_>,
) -> HullabalooResult<Graph> {
    adjacency_from_incidence_with::<Graph>(sets, universe_size, adj_dim, options)
}

/// Build adjacency from incidence sets, writing into an arbitrary sink.
pub fn adjacency_from_incidence_with<S: AdjacencyBuilder>(
    sets: &[Vec<usize>],
    universe_size: usize,
    adj_dim: usize,
    options: IncidenceAdjacencyOptions<'_>,
) -> HullabalooResult<S::Output> {
    let family_size = sets.len();
    if family_size == 0 {
        return Ok(S::new(0).finish());
    }

    let excluded = options.excluded_nodes;
    if let Some(mask) = excluded {
        if mask.len() != family_size {
            return Err(HullabalooError::InvalidInput {
                message: format!(
                    "excluded_nodes length mismatch (excluded_nodes={} family_size={})",
                    mask.len(),
                    family_size
                ),
            });
        }
    }
    let is_excluded = |idx: usize| excluded.is_some_and(|m| m[idx]);

    let active = options.active_rows;
    if let Some(mask) = active {
        if mask.len() != universe_size {
            return Err(HullabalooError::InvalidInput {
                message: format!(
                    "active_rows length mismatch (active_rows={} universe_size={})",
                    mask.len(),
                    universe_size
                ),
            });
        }
    }

    let mut rows_by_node: Vec<Vec<usize>> = Vec::with_capacity(family_size);
    for (idx, rows) in sets.iter().enumerate() {
        if is_excluded(idx) {
            rows_by_node.push(Vec::new());
            continue;
        }

        let mut filtered: Vec<usize> = Vec::new();
        if let Some(active) = active {
            for &row in rows {
                if row >= universe_size {
                    return Err(HullabalooError::InvalidInput {
                        message: format!(
                            "row index out of range (node={idx} row={row} universe_size={universe_size})"
                        ),
                    });
                }
                if active[row] {
                    filtered.push(row);
                }
            }
        } else {
            for &row in rows {
                if row >= universe_size {
                    return Err(HullabalooError::InvalidInput {
                        message: format!(
                            "row index out of range (node={idx} row={row} universe_size={universe_size})"
                        ),
                    });
                }
                filtered.push(row);
            }
        }

        debug_assert!(
            filtered.windows(2).all(|w| w[0] < w[1]),
            "adjacency_from_incidence expects per-node sets to be sorted + deduped"
        );
        rows_by_node.push(filtered);
    }

    adjacency_from_rows_by_node_with::<S>(
        &rows_by_node,
        universe_size,
        adj_dim,
        RowsByNodeAdjacencyOptions {
            excluded_nodes: excluded,
            candidate_edges: options.candidate_edges,
            assume_nondegenerate: options.assume_nondegenerate,
        },
    )
}

/// Build adjacency from pre-filtered per-node incidence rows.
///
/// `rows_by_node[i]` must be sorted + deduped, and contain only row indices `< row_capacity`.
pub fn adjacency_from_rows_by_node_with<S: AdjacencyBuilder>(
    rows_by_node: &[impl AsRef<[usize]>],
    row_capacity: usize,
    adj_dim: usize,
    options: RowsByNodeAdjacencyOptions<'_>,
) -> HullabalooResult<S::Output> {
    let family_size = rows_by_node.len();
    if family_size == 0 {
        return Ok(S::new(0).finish());
    }

    let excluded = options.excluded_nodes;
    if let Some(mask) = excluded {
        if mask.len() != family_size {
            return Err(HullabalooError::InvalidInput {
                message: format!(
                    "excluded_nodes length mismatch (excluded_nodes={} family_size={})",
                    mask.len(),
                    family_size
                ),
            });
        }
    }
    let is_excluded = |idx: usize| excluded.is_some_and(|m| m[idx]);

    let required = adj_dim.saturating_sub(2);

    let non_excluded = (0..family_size).filter(|&i| !is_excluded(i)).count();
    let mut sink = S::new(family_size);

    if non_excluded < 2 {
        return Ok(sink.finish());
    }

    // Edge case: when `required == 0` (adj_dim <= 2), overlap-based candidate generation can't see
    // empty intersections. Handle directly.
    if options.candidate_edges.is_none() && required == 0 {
        let non_excluded_indices: Vec<usize> =
            (0..family_size).filter(|&i| !is_excluded(i)).collect();
        if options.assume_nondegenerate || non_excluded_indices.len() == 2 {
            for (pos, &i) in non_excluded_indices.iter().enumerate() {
                for &j in non_excluded_indices.iter().skip(pos + 1) {
                    sink.add_undirected_edge(i, j);
                }
            }
        }
        return Ok(sink.finish());
    }

    if options.candidate_edges.is_none() && required >= 1 {
        let facet_dimension = required + 1;
        let simplicial = rows_by_node
            .iter()
            .enumerate()
            .all(|(idx, rows)| is_excluded(idx) || rows.as_ref().len() == facet_dimension);
        if simplicial {
            simplicial_ridge_hash_into_sink(rows_by_node, facet_dimension, &mut sink);
            return Ok(sink.finish());
        }
    }

    let membership = SparseRowMembershipIndex::new(rows_by_node, row_capacity);
    let mut face_rows: Vec<usize> = Vec::new();

    if let Some(edges) = options.candidate_edges {
        for &(i, j) in edges {
            if i == j || i >= family_size || j >= family_size {
                continue;
            }
            if is_excluded(i) || is_excluded(j) {
                continue;
            }
            intersect_sorted_rows(
                rows_by_node[i].as_ref(),
                rows_by_node[j].as_ref(),
                &mut face_rows,
            );
            if face_rows.len() < required {
                continue;
            }
            if !options.assume_nondegenerate
                && has_third_node_containing_face(&membership, &face_rows, i, j, non_excluded)
            {
                continue;
            }
            sink.add_undirected_edge(i, j);
        }
        return Ok(sink.finish());
    }

    let mut counts: Vec<u32> = vec![0; family_size];
    let mut touched: Vec<usize> = Vec::new();

    for i in 0..family_size {
        if is_excluded(i) {
            continue;
        }

        touched.clear();
        for &row in rows_by_node[i].as_ref() {
            debug_assert!(row < row_capacity, "row index out of range in rows_by_node");
            for &j in membership.members_of_row(row) {
                let c = counts[j];
                if c == 0 {
                    touched.push(j);
                }
                counts[j] = c + 1;
            }
        }

        for &j in &touched {
            if j <= i {
                continue;
            }
            if is_excluded(j) {
                continue;
            }
            if (counts[j] as usize) < required {
                continue;
            }
            if !options.assume_nondegenerate {
                intersect_sorted_rows(
                    rows_by_node[i].as_ref(),
                    rows_by_node[j].as_ref(),
                    &mut face_rows,
                );
                if face_rows.len() < required {
                    continue;
                }
                if has_third_node_containing_face(&membership, &face_rows, i, j, non_excluded) {
                    continue;
                }
            }
            sink.add_undirected_edge(i, j);
        }

        for &j in &touched {
            counts[j] = 0;
        }
    }

    Ok(sink.finish())
}

fn simplicial_ridge_hash_into_sink<S: AdjacencyBuilder>(
    facets: &[impl AsRef<[usize]>],
    facet_dimension: usize,
    sink: &mut S,
) {
    let facet_count = facets.len();
    let mut ridge_to_facets: AHashMap<Key, SmallVec<[usize; 2]>> = AHashMap::new();
    for (facet_idx, facet) in facets.iter().enumerate() {
        let facet = facet.as_ref();
        if facet.len() != facet_dimension || facet_dimension < 2 {
            continue;
        }
        for drop_pos in 0..facet.len() {
            let mut ridge = Key::with_capacity(facet.len().saturating_sub(1));
            ridge.extend(facet[..drop_pos].iter().copied());
            ridge.extend(facet[(drop_pos + 1)..].iter().copied());
            ridge_to_facets.entry(ridge).or_default().push(facet_idx);
        }
    }

    for incident in ridge_to_facets.values() {
        if incident.len() < 2 {
            continue;
        }
        for (pos, &a) in incident.iter().enumerate() {
            for &b in incident.iter().skip(pos + 1) {
                if a == b {
                    continue;
                }
                if a < facet_count && b < facet_count {
                    sink.add_undirected_edge(a, b);
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{IncidenceAdjacencyOptions, adjacency_from_incidence};

    #[test]
    fn square_facets_form_cycle() {
        // Unit square facets each contain two vertices (0..4).
        // Facet 0: {0,1}, facet 1: {1,3}, facet 2: {2,3}, facet 3: {0,2}
        let facets = vec![vec![0, 1], vec![1, 3], vec![2, 3], vec![0, 2]];
        let g =
            adjacency_from_incidence(&facets, 4, 3, IncidenceAdjacencyOptions::default()).unwrap();
        let degrees: Vec<usize> = g.adjacency.iter().map(|n| n.len()).collect();
        assert_eq!(degrees, vec![2, 2, 2, 2]);
    }
}