networkit-rs 0.1.0

Rust bindings for Networkit
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
use std::ops::Deref;

use cxx::UniquePtr;
use miette::{bail, IntoDiagnostic, Result};

use crate::bridge::{self, *};

pub struct Graph {
    pub(crate) inner: UniquePtr<bridge::Graph>,
}

unsafe impl Send for Graph {}

impl Deref for Graph {
    type Target = bridge::Graph;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl Clone for Graph {
    fn clone(&self) -> Self {
        Self {
            inner: CopyGraph(&self.inner),
        }
    }
}

impl From<UniquePtr<bridge::Graph>> for Graph {
    fn from(value: UniquePtr<bridge::Graph>) -> Self {
        Self { inner: value }
    }
}

impl Graph {
    pub fn new(n: u64, weighted: bool, directed: bool, edges_indexed: bool) -> Self {
        Self {
            inner: bridge::NewGraph(n, weighted, directed, edges_indexed),
        }
    }

    pub fn add_edge(&mut self, u: u64, v: u64, ew: Option<f64>, check_multi_edge: bool) -> bool {
        self.inner
            .pin_mut()
            .addEdge(u, v, ew.unwrap_or(1.), check_multi_edge)
    }

    pub fn add_node(&mut self) -> u64 {
        self.inner.pin_mut().addNode()
    }

    pub fn add_nodes(&mut self, number_of_new_nodes: u64) -> u64 {
        self.inner.pin_mut().addNodes(number_of_new_nodes)
    }

    pub fn check_consistency(&self) -> bool {
        self.inner.checkConsistency()
    }

    pub fn compact_edges(&mut self) {
        self.inner.pin_mut().compactEdges()
    }

    pub unsafe fn degree_unchecked(&self, v: u64) -> u64 {
        self.inner.degree(v)
    }

    pub fn degree(&self, v: u64) -> Result<u64> {
        if self.inner.hasNode(v) {
            Ok(unsafe { self.inner.degree(v) })
        } else {
            bail!("Node {} doesn't exist", v)
        }
    }

    pub unsafe fn degree_in_unchecked(&self, v: u64) -> u64 {
        self.inner.degreeIn(v)
    }

    pub fn degree_in(&self, v: u64) -> Result<u64> {
        if self.inner.hasNode(v) {
            Ok(unsafe { self.inner.degreeIn(v) })
        } else {
            bail!("Node {} doesn't exist", v)
        }
    }

    pub unsafe fn degree_out_unchecked(&self, v: u64) -> u64 {
        self.inner.degreeOut(v)
    }

    pub fn degree_out(&self, v: u64) -> Result<u64> {
        if self.inner.hasNode(v) {
            Ok(unsafe { self.inner.degreeOut(v) })
        } else {
            bail!("Node {} doesn't exist", v)
        }
    }

    pub fn edge_id(&self, u: u64, v: u64) -> Result<u64> {
        unsafe { self.inner.edgeId(u, v).into_diagnostic() }
    }

    pub fn has_edge(&self, u: u64, v: u64) -> bool {
        self.inner.hasEdge(u, v)
    }

    pub fn has_edge_ids(&self) -> bool {
        self.inner.hasEdgeIds()
    }

    pub fn has_node(&self, v: u64) -> bool {
        self.inner.hasNode(v)
    }

    pub unsafe fn increase_weight_unchecked(&mut self, u: u64, v: u64, ew: f64) -> Result<()> {
        self.inner
            .pin_mut()
            .increaseWeight(u, v, ew)
            .into_diagnostic()
    }

    pub fn increase_weight(&mut self, u: u64, v: u64, ew: f64) -> Result<()> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        if !self.inner.hasNode(v) {
            bail!("Node {} doesn't exist", v)
        }
        unsafe {
            self.inner
                .pin_mut()
                .increaseWeight(u, v, ew)
                .into_diagnostic()
        }
    }

    pub fn index_edges(&mut self, force: bool) {
        self.inner.pin_mut().indexEdges(force)
    }

    pub fn is_directed(&self) -> bool {
        self.inner.isDirected()
    }

    pub unsafe fn is_isolated_unchecked(&self, u: u64) -> Result<bool> {
        self.inner.isIsolated(u).into_diagnostic()
    }

    pub fn is_isolated(&self, u: u64) -> Result<bool> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        self.inner.isIsolated(u).into_diagnostic()
    }

    pub fn is_weighted(&self) -> bool {
        self.inner.isWeighted()
    }

    pub fn number_of_edges(&self) -> u64 {
        self.inner.numberOfEdges()
    }

    pub fn number_of_nodes(&self) -> u64 {
        self.inner.numberOfNodes()
    }

    pub fn number_of_self_loops(&self) -> u64 {
        self.inner.numberOfSelfLoops()
    }

    pub fn remove_all_edges(&mut self) {
        self.inner.pin_mut().removeAllEdges()
    }

    pub fn remove_edge(&mut self, u: u64, v: u64) -> Result<()> {
        self.inner.pin_mut().removeEdge(u, v).into_diagnostic()
    }

    pub fn remove_multi_edges(&mut self) {
        self.inner.pin_mut().removeMultiEdges()
    }

    pub unsafe fn remove_node_unchecked(&mut self, u: u64) {
        self.inner.pin_mut().removeNode(u)
    }

    pub fn remove_node(&mut self, u: u64) -> Result<()> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        unsafe { self.inner.pin_mut().removeNode(u) };
        Ok(())
    }

    pub fn remove_self_loops(&mut self) {
        self.inner.pin_mut().removeSelfLoops()
    }

    pub unsafe fn restore_node_unchecked(&mut self, u: u64) {
        self.inner.pin_mut().restoreNode(u)
    }

    pub fn restore_node(&mut self, u: u64) -> Result<()> {
        if u >= self.inner.upperNodeIdBound() {
            bail!("Node {} out of bound", u)
        }
        unsafe { self.inner.pin_mut().restoreNode(u) }
        Ok(())
    }
    pub unsafe fn set_weight_unchecked(&mut self, u: u64, v: u64, ew: f64) -> Result<()> {
        self.inner.pin_mut().setWeight(u, v, ew).into_diagnostic()
    }

    pub fn set_weight(&mut self, u: u64, v: u64, ew: f64) -> Result<()> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        if !self.inner.hasNode(v) {
            bail!("Node {} doesn't exist", v)
        }
        unsafe { self.inner.pin_mut().setWeight(u, v, ew).into_diagnostic() }
    }

    pub fn sort_edges(&mut self) {
        self.inner.pin_mut().sortEdges()
    }

    pub unsafe fn swap_edge_unchecked(&mut self, s1: u64, t1: u64, s2: u64, t2: u64) {
        self.inner.pin_mut().swapEdge(s1, t1, s2, t2)
    }

    pub fn swap_edge(&mut self, s1: u64, t1: u64, s2: u64, t2: u64) -> Result<()> {
        for u in [s1, t1, s2, t2] {
            if !self.inner.hasNode(u) {
                bail!("Node {} doesn't exist", u)
            }
        }
        unsafe { self.inner.pin_mut().swapEdge(s1, t1, s2, t2) }
        Ok(())
    }
    pub fn total_edge_weight(&self) -> f64 {
        self.inner.totalEdgeWeight()
    }
    pub fn upper_edge_id_bound(&self) -> u64 {
        self.inner.upperEdgeIdBound()
    }
    pub fn upper_node_id_bound(&self) -> u64 {
        self.inner.upperNodeIdBound()
    }

    pub unsafe fn weight_unchecked(&self, u: u64, v: u64) -> f64 {
        self.inner.weight(u, v)
    }

    pub fn weight(&self, u: u64, v: u64) -> Result<f64> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        if !self.inner.hasNode(v) {
            bail!("Node {} doesn't exist", v)
        }
        Ok(unsafe { self.inner.weight(u, v) })
    }

    pub unsafe fn weighted_degree_unchecked(
        self: &Graph,
        u: u64,
        count_self_loops_twice: bool,
    ) -> f64 {
        self.inner.weightedDegree(u, count_self_loops_twice)
    }

    pub fn weighted_degree(&self, u: u64, count_self_loops_twice: bool) -> Result<f64> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        Ok(unsafe { self.inner.weightedDegree(u, count_self_loops_twice) })
    }
    pub unsafe fn weighted_degree_in_unchecked(
        self: &Graph,
        u: u64,
        count_self_loops_twice: bool,
    ) -> f64 {
        self.inner.weightedDegreeIn(u, count_self_loops_twice)
    }

    pub fn weighted_degree_in(&self, u: u64, count_self_loops_twice: bool) -> Result<f64> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }
        Ok(unsafe { self.inner.weightedDegreeIn(u, count_self_loops_twice) })
    }

    pub fn iter_nodes<'a>(&'a self) -> impl Iterator<Item = u64> + 'a {
        struct It(UniquePtr<GraphNodeIter>);

        impl Iterator for It {
            type Item = u64;
            fn next(&mut self) -> Option<Self::Item> {
                let mut cur = 0;
                if self.0.pin_mut().advance(&mut cur) {
                    Some(cur)
                } else {
                    None
                }
            }
        }

        It(NewGraphNodeIter(&self.inner))
    }
    pub fn iter_edges<'a>(&'a self) -> impl Iterator<Item = (u64, u64)> + 'a {
        struct It(UniquePtr<GraphEdgeIter>);

        impl Iterator for It {
            type Item = (u64, u64);
            fn next(&mut self) -> Option<Self::Item> {
                let mut src = 0;
                let mut dst = 0;
                if self.0.pin_mut().advance(&mut src, &mut dst) {
                    Some((src, dst))
                } else {
                    None
                }
            }
        }

        It(NewGraphEdgeIter(&self.inner))
    }

    pub fn iter_edges_weight<'a>(&'a self) -> impl Iterator<Item = (u64, u64, f64)> + 'a {
        struct It(UniquePtr<GraphEdgeWeightIter>);

        impl Iterator for It {
            type Item = (u64, u64, f64);
            fn next(&mut self) -> Option<Self::Item> {
                let mut src = 0;
                let mut dst = 0;
                let mut wt = 0.0;
                if self.0.pin_mut().advance(&mut src, &mut dst, &mut wt) {
                    Some((src, dst, wt))
                } else {
                    None
                }
            }
        }

        It(NewGraphEdgeWeightIter(&self.inner))
    }
    pub fn iter_neighbours<'a>(&'a self, u: u64) -> Result<impl Iterator<Item = u64> + 'a> {
        self.iter_neighbours_impl(u, false)
    }
    pub fn iter_in_neighbours<'a>(&'a self, u: u64) -> Result<impl Iterator<Item = u64> + 'a> {
        self.iter_neighbours_impl(u, true)
    }
    fn iter_neighbours_impl<'a>(
        &'a self,
        u: u64,
        in_neighbours: bool,
    ) -> Result<impl Iterator<Item = u64> + 'a> {
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }

        struct It(UniquePtr<GraphNeighbourIter>);
        impl Iterator for It {
            type Item = u64;
            fn next(&mut self) -> Option<Self::Item> {
                let mut cur = 0;
                if self.0.pin_mut().advance(&mut cur) {
                    Some(cur)
                } else {
                    None
                }
            }
        }
        Ok(It(unsafe {
            NewGraphNeighbourIter(&self.inner, u, in_neighbours)
        }))
    }
    pub fn iter_neighbours_weight<'a>(
        &'a self,
        u: u64,
    ) -> Result<impl Iterator<Item = (u64, f64)> + 'a> {
        self.iter_neighbours_weight_impl(u, false)
    }
    pub fn iter_in_neighbours_weight<'a>(
        &'a self,
        u: u64,
    ) -> Result<impl Iterator<Item = (u64, f64)> + 'a> {
        self.iter_neighbours_weight_impl(u, true)
    }
    fn iter_neighbours_weight_impl<'a>(
        &'a self,
        u: u64,
        in_neighbours: bool,
    ) -> Result<impl Iterator<Item = (u64, f64)> + 'a> {
        if !self.inner.isWeighted() {
            bail!("Graph is unweighted")
        }
        if !self.inner.hasNode(u) {
            bail!("Node {} doesn't exist", u)
        }

        struct It(UniquePtr<GraphNeighbourWeightIter>);
        impl Iterator for It {
            type Item = (u64, f64);
            fn next(&mut self) -> Option<Self::Item> {
                let mut cur = 0;
                let mut wt = 0.0;
                if self.0.pin_mut().advance(&mut cur, &mut wt) {
                    Some((cur, wt))
                } else {
                    None
                }
            }
        }
        Ok(It(unsafe {
            NewGraphNeighbourWeightIter(&self.inner, u, in_neighbours).into_diagnostic()?
        }))
    }
}