lattix 0.8.1

Knowledge graph data structures
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
//! Integration tests for centrality algorithms.
//!
//! These tests verify that centrality algorithms work correctly on
//! realistic graph structures and produce consistent, mathematically
//! sound results.

use lattix::algo::centrality::{
    betweenness_centrality, closeness_centrality, degree_centrality, eigenvector_centrality, hits,
    katz_centrality, BetweennessConfig, ClosenessConfig, EigenvectorConfig, HitsConfig, KatzConfig,
};
use lattix::algo::pagerank::{pagerank, PageRankConfig};
use lattix::{KnowledgeGraph, Triple};

/// Create a small social network for testing.
///
/// Structure:
/// ```text
///        Alice
///       /  |  \
///      v   v   v
///    Bob  Carol Dave
///      \   |   /
///       v  v  v
///         Eve
/// ```
fn social_network() -> KnowledgeGraph {
    let mut kg = KnowledgeGraph::new();
    // Alice connects to everyone
    kg.add_triple(Triple::new("Alice", "friends", "Bob"));
    kg.add_triple(Triple::new("Alice", "friends", "Carol"));
    kg.add_triple(Triple::new("Alice", "friends", "Dave"));
    // Bob, Carol, Dave connect to Eve
    kg.add_triple(Triple::new("Bob", "friends", "Eve"));
    kg.add_triple(Triple::new("Carol", "friends", "Eve"));
    kg.add_triple(Triple::new("Dave", "friends", "Eve"));
    kg
}

/// Create a citation network with clear hubs and authorities.
///
/// Structure: Survey papers cite primary papers.
/// ```text
/// Survey1 ---> Paper1
/// Survey1 ---> Paper2
/// Survey2 ---> Paper1
/// Survey2 ---> Paper2
/// Survey2 ---> Paper3
/// ```
fn citation_network() -> KnowledgeGraph {
    let mut kg = KnowledgeGraph::new();
    kg.add_triple(Triple::new("Survey1", "cites", "Paper1"));
    kg.add_triple(Triple::new("Survey1", "cites", "Paper2"));
    kg.add_triple(Triple::new("Survey2", "cites", "Paper1"));
    kg.add_triple(Triple::new("Survey2", "cites", "Paper2"));
    kg.add_triple(Triple::new("Survey2", "cites", "Paper3"));
    kg
}

/// Create a long chain graph.
fn chain_graph(length: usize) -> KnowledgeGraph {
    let mut kg = KnowledgeGraph::new();
    for i in 0..length {
        let from = format!("N{i}");
        let to = format!("N{}", i + 1);
        kg.add_triple(Triple::new(from, "next", to));
    }
    kg
}

/// Create a complete graph where everyone connects to everyone.
fn complete_graph(n: usize) -> KnowledgeGraph {
    let mut kg = KnowledgeGraph::new();
    for i in 0..n {
        for j in 0..n {
            if i != j {
                let from = format!("N{i}");
                let to = format!("N{j}");
                kg.add_triple(Triple::new(from, "connected", to));
            }
        }
    }
    kg
}

// ============================================================================
// Degree Centrality Tests
// ============================================================================

#[test]
fn test_degree_social_network() {
    let kg = social_network();
    let degrees = degree_centrality(&kg);

    // Alice has highest out-degree (3 outgoing)
    let alice = degrees.get("Alice").unwrap();
    assert_eq!(alice.out_degree, 3);
    assert_eq!(alice.in_degree, 0);

    // Eve has highest in-degree (3 incoming)
    let eve = degrees.get("Eve").unwrap();
    assert_eq!(eve.in_degree, 3);
    assert_eq!(eve.out_degree, 0);
}

#[test]
fn test_degree_complete_graph() {
    let kg = complete_graph(4);
    let degrees = degree_centrality(&kg);

    // Everyone should have n-1 in and n-1 out
    for (name, deg) in degrees {
        assert_eq!(deg.in_degree, 3, "{name} in-degree");
        assert_eq!(deg.out_degree, 3, "{name} out-degree");
        // Normalized should be 1.0 (connected to all n-1 others)
        assert!((deg.in_normalized - 1.0).abs() < 1e-6);
    }
}

// ============================================================================
// Betweenness Centrality Tests
// ============================================================================

#[test]
fn test_betweenness_chain() {
    // In a chain A -> B -> C -> D -> E, middle nodes should have highest betweenness
    let kg = chain_graph(4); // N0 -> N1 -> N2 -> N3 -> N4

    let config = BetweennessConfig {
        normalized: false,
        undirected: false,
    };
    let scores = betweenness_centrality(&kg, config);

    // Endpoints have 0 betweenness
    assert_eq!(*scores.get("N0").unwrap(), 0.0);
    assert_eq!(*scores.get("N4").unwrap(), 0.0);

    // Middle nodes have positive betweenness
    let n1 = *scores.get("N1").unwrap();
    let n2 = *scores.get("N2").unwrap();
    let n3 = *scores.get("N3").unwrap();

    // N2 should have highest (most paths go through it)
    assert!(n2 >= n1, "N2={n2} should be >= N1={n1}");
    assert!(n2 >= n3, "N2={n2} should be >= N3={n3}");
}

#[test]
fn test_betweenness_social_network() {
    let kg = social_network();

    let config = BetweennessConfig::default();
    let scores = betweenness_centrality(&kg, config);

    // Bob, Carol, Dave are bridges between Alice and Eve
    let bob = *scores.get("Bob").unwrap();
    let alice = *scores.get("Alice").unwrap();
    let _eve = *scores.get("Eve").unwrap();

    // Alice and Eve are sources/sinks, should have lower betweenness
    assert!(bob >= alice, "Bob={bob} should be >= Alice={alice}");
}

// ============================================================================
// Closeness Centrality Tests
// ============================================================================

#[test]
fn test_closeness_star() {
    let mut kg = KnowledgeGraph::new();
    // Star with hub in center (bidirectional)
    for leaf in ["A", "B", "C", "D"] {
        kg.add_triple(Triple::new("Hub", "rel", leaf));
        kg.add_triple(Triple::new(leaf, "rel", "Hub"));
    }

    let config = ClosenessConfig::default();
    let scores = closeness_centrality(&kg, config);

    let hub = *scores.get("Hub").unwrap();
    let leaf = *scores.get("A").unwrap();

    // Hub reaches everyone in 1 hop, leaves need 2 hops to reach each other
    assert!(
        hub > leaf,
        "Hub={hub} should be more central than leaf={leaf}"
    );
}

#[test]
fn test_closeness_complete_graph() {
    let kg = complete_graph(4);

    let config = ClosenessConfig {
        normalized: true,
        undirected: false,
        harmonic: true,
    };
    let scores = closeness_centrality(&kg, config);

    // In complete graph, everyone has same closeness (all distances = 1)
    let values: Vec<_> = scores.values().cloned().collect();
    let first = values[0];
    for v in &values {
        assert!(
            (v - first).abs() < 1e-6,
            "All should be equal in complete graph"
        );
    }
}

// ============================================================================
// Eigenvector Centrality Tests
// ============================================================================

#[test]
fn test_eigenvector_convergence() {
    let kg = complete_graph(5);

    let config = EigenvectorConfig::default();
    let scores = eigenvector_centrality(&kg, config);

    // All nodes should have equal centrality in complete graph
    let values: Vec<_> = scores.values().cloned().collect();
    let first = values[0];
    for v in &values {
        assert!(
            (v - first).abs() < 0.01,
            "Complete graph should have equal eigenvector centrality"
        );
    }
}

#[test]
fn test_eigenvector_normalized() {
    let kg = social_network();

    let scores = eigenvector_centrality(&kg, EigenvectorConfig::default());

    // L2 norm should be 1
    let norm: f64 = scores.values().map(|x| x * x).sum::<f64>().sqrt();
    assert!((norm - 1.0).abs() < 1e-4, "Should be L2 normalized: {norm}");
}

// ============================================================================
// Katz Centrality Tests
// ============================================================================

#[test]
fn test_katz_baseline() {
    // Katz with β > 0 ensures all nodes have positive score
    let kg = social_network();

    let config = KatzConfig::default();
    let scores = katz_centrality(&kg, config);

    for (name, score) in &scores {
        assert!(*score > 0.0, "{name} should have positive Katz score");
    }
}

#[test]
fn test_katz_chain_ordering() {
    // In a chain, nodes further along should have higher Katz (more paths reach them)
    let kg = chain_graph(3); // N0 -> N1 -> N2 -> N3

    let config = KatzConfig {
        normalized: false,
        ..Default::default()
    };
    let scores = katz_centrality(&kg, config);

    let n0 = *scores.get("N0").unwrap();
    let n1 = *scores.get("N1").unwrap();
    let n2 = *scores.get("N2").unwrap();
    let n3 = *scores.get("N3").unwrap();

    // More paths reach nodes further along
    assert!(n3 >= n2, "N3={n3} >= N2={n2}");
    assert!(n2 >= n1, "N2={n2} >= N1={n1}");
    assert!(n1 >= n0, "N1={n1} >= N0={n0}");
}

// ============================================================================
// PageRank Tests
// ============================================================================

#[test]
fn test_pagerank_sums_to_one() {
    let kg = social_network();

    let scores = pagerank(&kg, PageRankConfig::default());
    let total: f64 = scores.values().sum();

    assert!(
        (total - 1.0).abs() < 1e-4,
        "PageRank should sum to 1: {total}"
    );
}

#[test]
fn test_pagerank_dangling_nodes() {
    // Eve is a dangling node (no outgoing edges)
    let kg = social_network();

    let scores = pagerank(&kg, PageRankConfig::default());

    // Eve should still have positive PageRank (receives from Bob, Carol, Dave)
    let eve = *scores.get("Eve").unwrap();
    assert!(
        eve > 0.0,
        "Dangling node Eve should have positive PR: {eve}"
    );

    // Eve should have highest PageRank (all paths lead to Eve)
    let alice = *scores.get("Alice").unwrap();
    assert!(eve > alice, "Eve={eve} should be > Alice={alice}");
}

// ============================================================================
// HITS Tests
// ============================================================================

#[test]
fn test_hits_citation_network() {
    let kg = citation_network();

    let scores = hits(&kg, HitsConfig::default());

    // Surveys should be hubs (they cite papers)
    let survey1 = scores.get("Survey1").unwrap();
    let survey2 = scores.get("Survey2").unwrap();

    // Papers should be authorities (they are cited)
    let paper1 = scores.get("Paper1").unwrap();

    assert!(
        survey1.hub > survey1.authority,
        "Survey1 should be more hub than authority"
    );
    assert!(
        paper1.authority > paper1.hub,
        "Paper1 should be more authority than hub"
    );

    // Survey2 cites more papers, should have higher hub score
    assert!(
        survey2.hub > survey1.hub,
        "Survey2={} should be better hub than Survey1={}",
        survey2.hub,
        survey1.hub
    );
}

#[test]
fn test_hits_normalized() {
    let kg = citation_network();

    let scores = hits(
        &kg,
        HitsConfig {
            normalized: true,
            ..Default::default()
        },
    );

    let hub_sum: f64 = scores.values().map(|s| s.hub).sum();
    let auth_sum: f64 = scores.values().map(|s| s.authority).sum();

    assert!(
        (hub_sum - 1.0).abs() < 1e-4,
        "Hub sum should be 1: {hub_sum}"
    );
    assert!(
        (auth_sum - 1.0).abs() < 1e-4,
        "Auth sum should be 1: {auth_sum}"
    );
}

// ============================================================================
// Cross-Algorithm Consistency Tests
// ============================================================================

#[test]
fn test_algorithms_agree_on_obvious_cases() {
    // In a star graph with bidirectional edges, the hub should be most central
    // by ALL measures
    let mut kg = KnowledgeGraph::new();
    for leaf in ["A", "B", "C", "D", "E"] {
        kg.add_triple(Triple::new("Hub", "rel", leaf));
        kg.add_triple(Triple::new(leaf, "rel", "Hub"));
    }

    let degrees = degree_centrality(&kg);
    let closeness = closeness_centrality(&kg, ClosenessConfig::default());
    let eigenvector = eigenvector_centrality(&kg, EigenvectorConfig::default());
    let katz = katz_centrality(&kg, KatzConfig::default());
    let pr = pagerank(&kg, PageRankConfig::default());

    let hub_degree = degrees.get("Hub").unwrap().total();
    let leaf_degree = degrees.get("A").unwrap().total();
    assert!(hub_degree > leaf_degree, "Hub should have higher degree");

    let hub_close = *closeness.get("Hub").unwrap();
    let leaf_close = *closeness.get("A").unwrap();
    assert!(hub_close > leaf_close, "Hub should have higher closeness");

    let hub_eigen = *eigenvector.get("Hub").unwrap();
    let leaf_eigen = *eigenvector.get("A").unwrap();
    assert!(hub_eigen > leaf_eigen, "Hub should have higher eigenvector");

    let hub_katz = *katz.get("Hub").unwrap();
    let leaf_katz = *katz.get("A").unwrap();
    assert!(hub_katz >= leaf_katz, "Hub should have higher Katz");

    let hub_pr = *pr.get("Hub").unwrap();
    let leaf_pr = *pr.get("A").unwrap();
    assert!(hub_pr > leaf_pr, "Hub should have higher PageRank");
}

#[test]
fn test_empty_graph() {
    let kg = KnowledgeGraph::new();

    assert!(degree_centrality(&kg).is_empty());
    assert!(betweenness_centrality(&kg, BetweennessConfig::default()).is_empty());
    assert!(closeness_centrality(&kg, ClosenessConfig::default()).is_empty());
    assert!(eigenvector_centrality(&kg, EigenvectorConfig::default()).is_empty());
    assert!(katz_centrality(&kg, KatzConfig::default()).is_empty());
    assert!(pagerank(&kg, PageRankConfig::default()).is_empty());
    assert!(hits(&kg, HitsConfig::default()).is_empty());
}

#[test]
fn test_single_node() {
    let mut kg = KnowledgeGraph::new();
    kg.add_triple(Triple::new("A", "rel", "A")); // self-loop creates entity

    let degrees = degree_centrality(&kg);
    assert_eq!(degrees.len(), 1);
}