geometric-traits 0.1.0

Trait-based algebraic and graph algorithms for Rust, supporting no_std environments
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

//! Implementations of traits from the graph crate for the
//! [`RangedCSR2D`] data structure.

pub mod ranged_csr2d;
use core::fmt::Debug;

use multi_ranged::{MultiRanged, Step};
use num_traits::{AsPrimitive, Zero};
pub use ranged_csr2d::RangedCSR2D;

use crate::{
    errors::builder::edges::EdgesBuilderError,
    traits::{
        BidirectionalVocabulary, BipartiteGraph, Edges, Graph, GrowableEdges, Matrix2D,
        Matrix2DRef, MonoplexGraph, PositiveInteger, SizedSparseMatrix, SparseMatrix,
        SparseMatrixMut, TryFromUsize,
    },
};

impl<SparseIndex, RowIndex, R> Edges for RangedCSR2D<SparseIndex, RowIndex, R>
where
    R: MultiRanged,
    RowIndex: Step + PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    SparseIndex: TryFromUsize + AsPrimitive<usize> + PositiveInteger,
    R::Step: PositiveInteger + TryFromUsize + AsPrimitive<usize>,
    <RowIndex as TryFrom<usize>>::Error: Debug,
    <<R as MultiRanged>::Step as TryFrom<usize>>::Error: Debug,
{
    type Edge = (<Self as Matrix2D>::RowIndex, <Self as Matrix2D>::ColumnIndex);
    type SourceNodeId = <Self as Matrix2D>::RowIndex;
    type DestinationNodeId = <Self as Matrix2D>::ColumnIndex;
    type EdgeId = SparseIndex;
    type Matrix = Self;

    #[inline]
    fn matrix(&self) -> &Self::Matrix {
        self
    }
}

impl<SparseIndex, RowIndex, R> GrowableEdges for RangedCSR2D<SparseIndex, RowIndex, R>
where
    R: MultiRanged,
    RowIndex: Step + PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    SparseIndex: TryFromUsize + AsPrimitive<usize> + PositiveInteger + 'static,
    R::Step: PositiveInteger + TryFromUsize + AsPrimitive<usize>,
    <RowIndex as TryFrom<usize>>::Error: Debug,
    <R::Step as TryFrom<usize>>::Error: Debug,
{
    type GrowableMatrix = Self;
    type Error = EdgesBuilderError<Self>;

    #[inline]
    fn matrix_mut(&mut self) -> &mut Self::GrowableMatrix {
        self
    }

    #[inline]
    fn with_capacity(number_of_edges: Self::EdgeId) -> Self {
        <Self as SparseMatrixMut>::with_sparse_capacity(number_of_edges)
    }

    #[inline]
    fn with_shape(shape: <Self::GrowableMatrix as SparseMatrixMut>::MinimalShape) -> Self {
        <Self as SparseMatrixMut>::with_sparse_shape(shape)
    }

    #[inline]
    fn with_shaped_capacity(
        shape: <Self::GrowableMatrix as SparseMatrixMut>::MinimalShape,
        number_of_edges: Self::EdgeId,
    ) -> Self {
        <Self as SparseMatrixMut>::with_sparse_shaped_capacity(shape, number_of_edges)
    }
}

impl<SparseIndex, RowIndex, R> Graph for RangedCSR2D<SparseIndex, RowIndex, R>
where
    R: MultiRanged,
    RowIndex: Step + PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    SparseIndex: TryFromUsize + AsPrimitive<usize> + PositiveInteger,
    R::Step: PositiveInteger + TryFromUsize + AsPrimitive<usize>,
    <RowIndex as TryFrom<usize>>::Error: Debug,
    <<R as MultiRanged>::Step as TryFrom<usize>>::Error: Debug,
{
    #[inline]
    fn has_nodes(&self) -> bool {
        self.number_of_rows() > <Self as Matrix2D>::RowIndex::zero()
            && self.number_of_columns() > <Self as Matrix2D>::ColumnIndex::zero()
    }

    #[inline]
    fn has_edges(&self) -> bool {
        self.number_of_defined_values() > <Self as SparseMatrix>::SparseIndex::zero()
    }
}

impl<SparseIndex, RowIndex, R> MonoplexGraph for RangedCSR2D<SparseIndex, RowIndex, R>
where
    R: MultiRanged,
    RowIndex: Step + PositiveInteger + AsPrimitive<usize> + TryFromUsize,
    SparseIndex: TryFromUsize + AsPrimitive<usize> + PositiveInteger,
    R::Step: PositiveInteger + TryFromUsize + AsPrimitive<usize>,
    <RowIndex as TryFrom<usize>>::Error: Debug,
    <<R as MultiRanged>::Step as TryFrom<usize>>::Error: Debug,
{
    type Edge = (<Self as Matrix2D>::RowIndex, <Self as Matrix2D>::ColumnIndex);
    type Edges = Self;

    #[inline]
    fn edges(&self) -> &Self::Edges {
        self
    }
}

impl<SparseIndex, RowIndex, R> BipartiteGraph for RangedCSR2D<SparseIndex, RowIndex, R>
where
    R: MultiRanged,
    RowIndex: Step
        + PositiveInteger
        + AsPrimitive<usize>
        + TryFromUsize
        + BidirectionalVocabulary<
            SourceSymbol = <Self as Matrix2D>::RowIndex,
            DestinationSymbol = <Self as Matrix2D>::RowIndex,
        >,
    SparseIndex: TryFromUsize + AsPrimitive<usize> + PositiveInteger,
    R::Step: TryFromUsize
        + BidirectionalVocabulary<
            SourceSymbol = <Self as Matrix2D>::ColumnIndex,
            DestinationSymbol = <Self as Matrix2D>::ColumnIndex,
        > + AsPrimitive<usize>
        + PositiveInteger,
    <RowIndex as TryFrom<usize>>::Error: Debug,
    <<R as MultiRanged>::Step as TryFrom<usize>>::Error: Debug,
{
    type LeftNodeId = <Self as Matrix2D>::RowIndex;
    type RightNodeId = <Self as Matrix2D>::ColumnIndex;
    type LeftNodeSymbol = <Self as Matrix2D>::RowIndex;
    type RightNodeSymbol = <Self as Matrix2D>::ColumnIndex;
    type LeftNodes = <Self as Matrix2D>::RowIndex;
    type RightNodes = <Self as Matrix2D>::ColumnIndex;

    #[inline]
    fn left_nodes_vocabulary(&self) -> &Self::LeftNodes {
        self.number_of_rows_ref()
    }

    #[inline]
    fn right_nodes_vocabulary(&self) -> &Self::RightNodes {
        self.number_of_columns_ref()
    }
}