ariadnetor-tensor 0.0.3

Tensor library with support for dense and block-sparse tensors
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

//! Construction-level tests for the joined `BlockSparseTensorData<T, S>`
//! surface: flux-allowed-block enumeration via the `zeros` and
//! `random` constructors, basic accessors, and CoW semantics on
//! `block_data_mut`.

use ariadnetor_core::backend::MemoryOrder;
use rand::SeedableRng;

use crate::block_sparse::*;
use crate::sector::{U1Sector, Z2Sector};
use crate::test_fixtures::{legs, out_in_legs, square_legs};

// ---------------------------------------------------------------------------
// zeros constructor
// ---------------------------------------------------------------------------

#[test]
fn zeros_u1_identity_flux() {
    let bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        square_legs(vec![(U1Sector(0), 2), (U1Sector(1), 3)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );

    // Allowed: (0,0) size 4, (1,1) size 9
    assert_eq!(bs.num_blocks(), 2);
    assert_eq!(bs.stored_len(), 13);
    assert_eq!(bs.shape(), &[5, 5]);

    // Data is zero-filled
    let d00 = bs.block_data(&BlockCoord(vec![0, 0])).unwrap();
    assert!(d00.iter().all(|&v| v == 0.0));
    let d11 = bs.block_data(&BlockCoord(vec![1, 1])).unwrap();
    assert!(d11.iter().all(|&v| v == 0.0));

    // Non-allowed blocks are absent
    assert!(bs.block_data(&BlockCoord(vec![0, 1])).is_none());
    assert!(bs.block_data(&BlockCoord(vec![1, 0])).is_none());
}

#[test]
fn zeros_u1_nonzero_flux() {
    let bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        out_in_legs(
            vec![(U1Sector(0), 2), (U1Sector(1), 3)],
            vec![(U1Sector(0), 4)],
        ),
        U1Sector(1),
        MemoryOrder::RowMajor,
    );

    // Allowed: (1,0) Out(1) + In(0).dual() = 1 + 0 = 1 = flux  size = 3*4 = 12
    assert_eq!(bs.num_blocks(), 1);
    assert_eq!(bs.stored_len(), 12);
    assert!(bs.block_data(&BlockCoord(vec![1, 0])).is_some());
}

#[test]
fn zeros_z2() {
    let bs = BlockSparseTensorData::<f64, Z2Sector>::zeros(
        out_in_legs(
            vec![(Z2Sector::new(0), 2), (Z2Sector::new(1), 3)],
            vec![(Z2Sector::new(0), 4), (Z2Sector::new(1), 5)],
        ),
        Z2Sector::new(0),
        MemoryOrder::RowMajor,
    );

    // Z2: dual is identity. Allowed if Out(a) fuse In(b).dual() = a+b mod 2 = 0
    // (0,0): 0+0=0 ✓  size=2*4=8
    // (1,1): 1+1=0 ✓  size=3*5=15
    assert_eq!(bs.num_blocks(), 2);
    assert_eq!(bs.stored_len(), 23);
}

#[test]
fn zeros_rank3() {
    let bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        legs([
            (vec![(U1Sector(0), 2), (U1Sector(1), 1)], Direction::Out),
            (vec![(U1Sector(0), 3)], Direction::Out),
            (vec![(U1Sector(0), 2), (U1Sector(1), 1)], Direction::In),
        ]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );

    // (0,0,0): 0+0+0 = 0 ✓  size=2*3*2=12
    // (1,0,1): 1+0+(-1) = 0 ✓  size=1*3*1=3
    assert_eq!(bs.num_blocks(), 2);
    assert_eq!(bs.stored_len(), 15);
}

#[test]
fn zeros_rank0_identity_flux() {
    let bs =
        BlockSparseTensorData::<f64, U1Sector>::zeros(vec![], U1Sector(0), MemoryOrder::RowMajor);
    assert_eq!(bs.rank(), 0);
    assert_eq!(bs.shape(), &[] as &[usize]);
    // Single scalar block
    assert_eq!(bs.num_blocks(), 1);
    assert_eq!(bs.stored_len(), 1);
    let d = bs.block_data(&BlockCoord(vec![])).unwrap();
    assert_eq!(d, &[0.0]);
}

#[test]
fn zeros_rank0_nonidentity_flux() {
    let bs =
        BlockSparseTensorData::<f64, U1Sector>::zeros(vec![], U1Sector(1), MemoryOrder::RowMajor);
    assert_eq!(bs.rank(), 0);
    // No block can satisfy non-identity flux with no legs
    assert_eq!(bs.num_blocks(), 0);
    assert_eq!(bs.stored_len(), 0);
}

#[test]
fn zeros_no_allowed_blocks() {
    // All sectors are charge 0/Out, flux = 1 → no blocks
    let bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        legs([
            (vec![(U1Sector(0), 2)], Direction::Out),
            (vec![(U1Sector(0), 3)], Direction::Out),
        ]),
        U1Sector(1),
        MemoryOrder::RowMajor,
    );
    assert_eq!(bs.num_blocks(), 0);
    assert_eq!(bs.stored_len(), 0);
    assert_eq!(bs.shape(), &[2, 3]);
}

#[test]
fn zeros_block_layout() {
    // Verify zeros produces correct block ordering and contiguous offsets
    let bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        square_legs(vec![(U1Sector(0), 2), (U1Sector(1), 3)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );

    assert_eq!(bs.num_blocks(), 2);
    // Blocks should be in lexicographic coord order
    let metas = bs.block_metas();
    assert_eq!(metas[0].coord, BlockCoord(vec![0, 0]));
    assert_eq!(metas[0].size, 4);
    assert_eq!(metas[1].coord, BlockCoord(vec![1, 1]));
    assert_eq!(metas[1].size, 9);
    // Offsets are contiguous
    assert_eq!(metas[0].offset, 0);
    assert_eq!(metas[1].offset, 4);
}

// ---------------------------------------------------------------------------
// block_data_mut
// ---------------------------------------------------------------------------

#[test]
fn block_data_mut_fills_block() {
    let mut bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        square_legs(vec![(U1Sector(0), 2), (U1Sector(1), 3)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );

    // Fill block (0,0)
    let d = bs.block_data_mut(&BlockCoord(vec![0, 0])).unwrap();
    for (i, v) in d.iter_mut().enumerate() {
        *v = (i + 1) as f64;
    }

    let d = bs.block_data(&BlockCoord(vec![0, 0])).unwrap();
    assert_eq!(d, &[1.0, 2.0, 3.0, 4.0]);

    // Other block unchanged
    let d11 = bs.block_data(&BlockCoord(vec![1, 1])).unwrap();
    assert!(d11.iter().all(|&v| v == 0.0));
}

#[test]
fn block_data_mut_nonexistent_returns_none() {
    let mut bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        square_legs(vec![(U1Sector(0), 2), (U1Sector(1), 3)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );
    assert!(bs.block_data_mut(&BlockCoord(vec![0, 1])).is_none());
}

#[test]
fn block_data_mut_cow_semantics() {
    let mut bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        square_legs(vec![(U1Sector(0), 2)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );
    let cloned = bs.clone();

    // Sanity: cloned tensor sees zeros, mutating bs after a clone
    // triggers Copy-on-Write at the storage half so cloned remains
    // unmodified.
    assert_eq!(cloned.block_data(&BlockCoord(vec![0, 0])).unwrap()[0], 0.0);

    let d = bs.block_data_mut(&BlockCoord(vec![0, 0])).unwrap();
    d[0] = 42.0;

    assert_eq!(bs.block_data(&BlockCoord(vec![0, 0])).unwrap()[0], 42.0);
    assert_eq!(cloned.block_data(&BlockCoord(vec![0, 0])).unwrap()[0], 0.0);
}

// ---------------------------------------------------------------------------
// random constructor
// ---------------------------------------------------------------------------

#[test]
fn random_matches_zeros_structure() {
    let mut rng = rand::rngs::StdRng::seed_from_u64(42);
    let indices = out_in_legs(
        vec![(U1Sector(0), 2), (U1Sector(1), 3), (U1Sector(2), 4)],
        vec![(U1Sector(0), 5), (U1Sector(1), 2)],
    );

    let zeros = BlockSparseTensorData::<f64, U1Sector>::zeros(
        indices.clone(),
        U1Sector(1),
        MemoryOrder::RowMajor,
    );
    let rand_bs = BlockSparseTensorData::<f64, U1Sector>::random(
        indices,
        U1Sector(1),
        MemoryOrder::RowMajor,
        &mut rng,
    );

    assert_eq!(rand_bs.shape(), zeros.shape());
    assert_eq!(rand_bs.num_blocks(), zeros.num_blocks());
    assert_eq!(rand_bs.stored_len(), zeros.stored_len());
    assert_eq!(rand_bs.flux(), zeros.flux());
    assert_eq!(rand_bs.indices().len(), zeros.indices().len());
}

#[test]
fn random_reproducible() {
    let indices = square_legs(vec![(U1Sector(0), 2), (U1Sector(1), 3)]);

    let mut rng1 = rand::rngs::StdRng::seed_from_u64(123);
    let bs1 = BlockSparseTensorData::<f64, U1Sector>::random(
        indices.clone(),
        U1Sector(0),
        MemoryOrder::RowMajor,
        &mut rng1,
    );

    let mut rng2 = rand::rngs::StdRng::seed_from_u64(123);
    let bs2 = BlockSparseTensorData::<f64, U1Sector>::random(
        indices,
        U1Sector(0),
        MemoryOrder::RowMajor,
        &mut rng2,
    );

    for meta in bs1.block_metas() {
        let d1 = bs1.block_data(&meta.coord).unwrap();
        let d2 = bs2.block_data(&meta.coord).unwrap();
        assert_eq!(d1, d2);
    }
}

#[test]
fn random_data_is_nonzero() {
    let mut rng = rand::rngs::StdRng::seed_from_u64(7);
    let bs = BlockSparseTensorData::<f64, U1Sector>::random(
        square_legs(vec![(U1Sector(0), 4), (U1Sector(1), 4)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
        &mut rng,
    );

    // With 32 random f64 values, probability of all zero is negligible
    let has_nonzero = bs.block_metas().iter().any(|meta| {
        bs.block_data(&meta.coord)
            .unwrap()
            .iter()
            .any(|&v| v != 0.0)
    });
    assert!(has_nonzero);
}

// ---------------------------------------------------------------------------
// is_allowed_block / block_shape (forwarded to layout)
// ---------------------------------------------------------------------------

#[test]
fn is_allowed_block_matches_flux_conservation() {
    let bs = BlockSparseTensorData::<f64, U1Sector>::zeros(
        square_legs(vec![(U1Sector(0), 2), (U1Sector(1), 3)]),
        U1Sector(0),
        MemoryOrder::RowMajor,
    );
    assert!(bs.is_allowed_block(&BlockCoord(vec![0, 0])));
    assert!(bs.is_allowed_block(&BlockCoord(vec![1, 1])));
    assert!(!bs.is_allowed_block(&BlockCoord(vec![0, 1])));
    assert!(!bs.is_allowed_block(&BlockCoord(vec![1, 0])));
}