holos-tda 0.9.0

Vietoris-Rips persistence and checked degree-Rips modules
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
//! Certificate validation and diagram reconstruction.

use rustc_hash::FxHashMap;
use sha2::{Digest, Sha256};

use crate::field::{MODULUS_LIMIT, is_prime};
use crate::{Bar, CriticalPair, CriticalSimplex, Diagram, RipsParams, SparseDistanceMatrix};

use super::model::{
    CertificateError, CertificateLimits, CertificateResult, ChangeColumn, ReductionCertificate,
};
use super::reduction::{FilteredComplex, FilteredTriangle, SparseColumn};
use super::region::critical_pair_record_order;
use super::wire::{check_bars, check_change_column, check_change_columns};

mod guards;

pub(super) use guards::{add_change_guards, add_pivot_guards, minimize_guards};

impl ReductionCertificate {
    /// Verify the change of basis, distinct pivots, and derived diagram.
    pub fn verify(
        &self,
        input: &SparseDistanceMatrix,
        limits: CertificateLimits,
    ) -> std::result::Result<Diagram, CertificateError> {
        Ok(self.verify_checked(input, limits)?.diagram)
    }
    fn verify_checked(
        &self,
        input: &SparseDistanceMatrix,
        limits: CertificateLimits,
    ) -> std::result::Result<CheckedReductions, CertificateError> {
        Ok(self.verify_parts(input, limits)?.1)
    }

    pub(super) fn verify_parts(
        &self,
        input: &SparseDistanceMatrix,
        limits: CertificateLimits,
    ) -> std::result::Result<(FilteredComplex, CheckedReductions), CertificateError> {
        let params = RipsParams::new(1).with_modulus(self.modulus);
        validate_header(input, params.max_dim, params.modulus, limits)?;
        if input.len() != self.vertex_count {
            return Err(CertificateError::new(format!(
                "input has {} vertices, certificate records {}",
                input.len(),
                self.vertex_count
            )));
        }
        let threshold = checked_threshold(self.threshold)?;
        if graph_digest(input, threshold) != self.graph_digest {
            return Err(CertificateError::new(
                "thresholded graph binding does not match",
            ));
        }
        let complex = FilteredComplex::build(input, threshold, limits)?;
        let checked = check_reductions(
            &complex,
            self.modulus,
            &self.edge_columns,
            &self.triangle_columns,
            limits,
        )?;
        if !diagram_bits_equal(&checked.diagram, &self.diagram) {
            return Err(CertificateError::new(
                "recorded diagram differs from the checked reduction",
            ));
        }
        Ok((complex, checked))
    }

    pub(crate) fn verify_with_h1_critical_pairs(
        &self,
        input: &SparseDistanceMatrix,
        limits: CertificateLimits,
    ) -> std::result::Result<(Diagram, Vec<(Bar, CriticalPair)>), CertificateError> {
        let checked = self.verify_checked(input, limits)?;
        Ok((checked.diagram, checked.h1_pairs))
    }

    pub(super) fn check_envelope(
        &self,
        limits: CertificateLimits,
    ) -> std::result::Result<(), CertificateError> {
        self.check_envelope_header(limits)?;
        let mut total_terms = 0usize;
        check_change_columns(
            "edge",
            &self.edge_columns,
            self.modulus,
            limits.max_terms,
            &mut total_terms,
        )?;
        check_change_columns(
            "triangle",
            &self.triangle_columns,
            self.modulus,
            limits.max_terms,
            &mut total_terms,
        )?;
        check_bars(&self.diagram, limits.max_bars)
    }

    fn check_envelope_header(&self, limits: CertificateLimits) -> CertificateResult<()> {
        if self.vertex_count > limits.max_vertices {
            return Err(CertificateError::new(format!(
                "{} vertices exceed the limit {}",
                self.vertex_count, limits.max_vertices
            )));
        }
        if !is_prime(self.modulus as u64) || self.modulus as u64 >= MODULUS_LIMIT {
            return Err(CertificateError::new(format!(
                "modulus must be a prime below {MODULUS_LIMIT}, got {}",
                self.modulus
            )));
        }
        checked_threshold(self.threshold)?;
        if self.edge_columns.len() > limits.max_edges {
            return Err(CertificateError::new(format!(
                "{} edge columns exceed the limit {}",
                self.edge_columns.len(),
                limits.max_edges
            )));
        }
        if self.triangle_columns.len() > limits.max_triangles {
            return Err(CertificateError::new(format!(
                "{} triangle columns exceed the limit {}",
                self.triangle_columns.len(),
                limits.max_triangles
            )));
        }
        Ok(())
    }
}
pub(super) struct CheckedReductions {
    pub(super) diagram: Diagram,
    pub(super) h1_pairs: Vec<(Bar, CriticalPair)>,
    pub(super) reduced_edges: Vec<SparseColumn>,
    pub(super) reduced_triangles: Vec<SparseColumn>,
}

pub(super) fn check_reductions(
    complex: &FilteredComplex,
    modulus: u32,
    edge_columns: &[ChangeColumn],
    triangle_columns: &[ChangeColumn],
    limits: CertificateLimits,
) -> std::result::Result<CheckedReductions, CertificateError> {
    let edge_boundaries = complex.edge_boundaries(modulus);
    let triangle_boundaries = complex.triangle_boundaries(modulus);
    let reduced_edges = check_matrix("edge", &edge_boundaries, edge_columns, modulus, limits)?;
    let reduced_triangles = check_matrix(
        "triangle",
        &triangle_boundaries,
        triangle_columns,
        modulus,
        limits,
    )?;
    let mut diagram = checked_h0_diagram(complex, &reduced_edges);
    let h1_deaths = h1_death_simplices(complex, &reduced_triangles);
    let h1_pairs = checked_h1_pairs(complex, &reduced_edges, &h1_deaths, &mut diagram);
    diagram.canonicalize();
    let mut h1_pairs = h1_pairs;
    h1_pairs.sort_by(critical_pair_record_order);
    Ok(CheckedReductions {
        diagram,
        h1_pairs,
        reduced_edges,
        reduced_triangles,
    })
}

fn checked_h0_diagram(complex: &FilteredComplex, reduced_edges: &[SparseColumn]) -> Diagram {
    let mut diagram = Diagram::default();
    let mut killed_vertices = vec![false; complex.vertex_count];
    for (column, reduced) in reduced_edges.iter().enumerate() {
        if let Some((pivot, _)) = reduced.pivot() {
            killed_vertices[pivot] = true;
            let death = complex.edges[column].value;
            if death > 0.0 {
                diagram.bars.push(Bar {
                    dim: 0,
                    birth: 0.0,
                    death,
                });
            }
        }
    }
    for killed in killed_vertices {
        if !killed {
            diagram.bars.push(Bar {
                dim: 0,
                birth: 0.0,
                death: f64::INFINITY,
            });
        }
    }
    diagram
}

fn h1_death_simplices<'a>(
    complex: &'a FilteredComplex,
    reduced_triangles: &[SparseColumn],
) -> FxHashMap<usize, &'a FilteredTriangle> {
    let mut h1_deaths = FxHashMap::default();
    for (column, reduced) in reduced_triangles.iter().enumerate() {
        if let Some((pivot, _)) = reduced.pivot() {
            h1_deaths.insert(pivot, &complex.triangles[column]);
        }
    }
    h1_deaths
}

fn checked_h1_pairs(
    complex: &FilteredComplex,
    reduced_edges: &[SparseColumn],
    h1_deaths: &FxHashMap<usize, &FilteredTriangle>,
    diagram: &mut Diagram,
) -> Vec<(Bar, CriticalPair)> {
    let mut h1_pairs = Vec::new();
    for (edge, reduced) in reduced_edges.iter().enumerate() {
        if !reduced.0.is_empty() {
            continue;
        }
        let birth = complex.edges[edge].value;
        let death_simplex = h1_deaths.get(&edge).copied();
        let death = death_simplex.map_or(f64::INFINITY, |triangle| triangle.value);
        if death > birth {
            let interval = Bar {
                dim: 1,
                birth,
                death,
            };
            diagram.bars.push(interval);
            h1_pairs.push((
                interval,
                CriticalPair {
                    birth: CriticalSimplex {
                        vertices: complex.edges[edge].vertices.to_vec(),
                        value: birth,
                    },
                    death: death_simplex.map(|triangle| CriticalSimplex {
                        vertices: triangle.vertices.to_vec(),
                        value: triangle.value,
                    }),
                },
            ));
        }
    }
    h1_pairs
}

fn check_matrix(
    label: &str,
    boundaries: &[SparseColumn],
    columns: &[ChangeColumn],
    modulus: u32,
    limits: CertificateLimits,
) -> std::result::Result<Vec<SparseColumn>, CertificateError> {
    if columns.len() != boundaries.len() {
        return Err(CertificateError::new(format!(
            "{label} matrix has {} columns, certificate records {}",
            boundaries.len(),
            columns.len()
        )));
    }
    let modulus64 = modulus as u64;
    let mut total_terms = 0usize;
    let mut reduced = Vec::with_capacity(columns.len());
    let mut pivots = FxHashMap::default();
    for (column_index, transform) in columns.iter().enumerate() {
        add_matrix_terms(
            &mut total_terms,
            transform.terms.len(),
            limits.max_terms,
            label,
        )?;
        let result = checked_matrix_column(
            label,
            column_index,
            transform,
            boundaries,
            modulus,
            modulus64,
        )?;
        if let Some((pivot, _)) = result.pivot() {
            if let Some(previous_column) = pivots.insert(pivot, column_index) {
                return Err(CertificateError::new(format!(
                    "{label} reduced columns {previous_column} and {column_index} share pivot {pivot}"
                )));
            }
        }
        reduced.push(result);
    }
    Ok(reduced)
}

fn add_matrix_terms(
    total: &mut usize,
    count: usize,
    maximum: usize,
    label: &str,
) -> CertificateResult<()> {
    *total = total
        .checked_add(count)
        .ok_or_else(|| CertificateError::new("certificate term count overflows usize"))?;
    if *total > maximum {
        return Err(CertificateError::new(format!(
            "{} {label} terms exceed the limit {maximum}",
            *total
        )));
    }
    Ok(())
}

fn checked_matrix_column(
    label: &str,
    column_index: usize,
    transform: &ChangeColumn,
    boundaries: &[SparseColumn],
    modulus: u32,
    modulus64: u64,
) -> CertificateResult<SparseColumn> {
    check_change_column(label, column_index, transform, modulus)?;
    let mut result = SparseColumn::default();
    for term in &transform.terms {
        result.add_scaled(&boundaries[term.index], term.coefficient as u64, modulus64);
    }
    Ok(result)
}

pub(super) fn validate_header(
    input: &SparseDistanceMatrix,
    max_dim: usize,
    modulus: u32,
    limits: CertificateLimits,
) -> std::result::Result<(), CertificateError> {
    if max_dim != 1 {
        return Err(CertificateError::new(
            "an algebraic certificate requires max_dim equal to 1",
        ));
    }
    if input.len() > limits.max_vertices {
        return Err(CertificateError::new(format!(
            "{} vertices exceed the limit {}",
            input.len(),
            limits.max_vertices
        )));
    }
    if !is_prime(modulus as u64) || modulus as u64 >= MODULUS_LIMIT {
        return Err(CertificateError::new(format!(
            "modulus must be a prime below {MODULUS_LIMIT}, got {modulus}"
        )));
    }
    Ok(())
}

pub(super) fn checked_threshold(
    threshold: Option<f64>,
) -> std::result::Result<f64, CertificateError> {
    let threshold = threshold.unwrap_or(f64::INFINITY);
    if threshold.is_nan() || threshold < 0.0 {
        return Err(CertificateError::new(format!(
            "threshold must be non-negative, got {threshold}"
        )));
    }
    Ok(threshold)
}

pub(super) fn graph_digest(input: &SparseDistanceMatrix, threshold: f64) -> [u8; 32] {
    let edges: Vec<_> = input
        .edges()
        .filter(|&(_, _, value)| value <= threshold)
        .collect();
    let mut hash = Sha256::new();
    hash.update(b"holos-certified-graph-v1");
    hash.update((input.len() as u64).to_be_bytes());
    hash.update((edges.len() as u64).to_be_bytes());
    for (u, v, value) in edges {
        hash.update((u as u64).to_be_bytes());
        hash.update((v as u64).to_be_bytes());
        hash.update(value.to_bits().to_be_bytes());
    }
    hash.finalize().into()
}

pub(super) fn edge_rank([u, v]: [usize; 2]) -> u128 {
    v as u128 * (v.saturating_sub(1)) as u128 / 2 + u as u128
}

pub(super) fn triangle_rank([u, v, w]: [usize; 3]) -> u128 {
    let choose2 = v as u128 * (v.saturating_sub(1)) as u128 / 2;
    let choose3 = w as u128 * (w.saturating_sub(1)) as u128 * (w.saturating_sub(2)) as u128 / 6;
    u as u128 + choose2 + choose3
}

pub(super) fn inverse_mod(value: u64, modulus: u64) -> u64 {
    let mut result = 1u64;
    let mut base = value;
    let mut exponent = modulus - 2;
    while exponent > 0 {
        if exponent & 1 == 1 {
            result = result * base % modulus;
        }
        base = base * base % modulus;
        exponent >>= 1;
    }
    result
}

pub(super) fn diagram_bits_equal(a: &Diagram, b: &Diagram) -> bool {
    a.bars.len() == b.bars.len()
        && a.bars.iter().zip(&b.bars).all(|(a, b)| {
            a.dim == b.dim
                && a.birth.to_bits() == b.birth.to_bits()
                && a.death.to_bits() == b.death.to_bits()
        })
}