rsspice 0.1.0

Pure Rust port of the SPICE Toolkit for space geometry
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
//
// GENERATED FILE
//

use super::*;
use f2rust_std::*;

const N: i32 = 99;
const TIGHT: f64 = 0.000000000001;
const TINY: f64 = 0.000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001;
const SEED0: i32 = 19810518;

//$Procedure F_VECTORG (Family of tests on general vector operations)
pub fn F_VECTORG(OK: &mut bool, ctx: &mut Context) -> f2rust_std::Result<()> {
    let mut VZERO: bool = false;
    let mut V_ZERO = StackArray::<f64, 99>::new(1..=N);
    let mut V_INDX = StackArray::<f64, 99>::new(1..=N);
    let mut V_RAN = StackArray::<f64, 99>::new(1..=N);
    let mut V_OUT = StackArray::<f64, 99>::new(1..=N);
    let mut V_EXPT = StackArray::<f64, 99>::new(1..=N);
    let mut V_TMP = StackArray::<f64, 99>::new(1..=N);
    let mut VECMAG: f64 = 0.0;
    let mut EVAL: f64 = 0.0;
    let mut EXPT: f64 = 0.0;
    let mut SCALE: f64 = 0.0;
    let mut DUMMY: f64 = 0.0;
    let mut SEED: i32 = 0;

    //
    // Test Utility Functions
    //

    //
    // SPICELIB Functions
    //

    //
    // Local parameters
    //

    //
    // Local Variables
    //

    //
    // Begin every test family with an open call.
    //
    testutil::TOPEN(b"F_VECTORG", ctx)?;

    //
    // Form vectors to be used for more than one test case.
    //

    //
    // A zero vector
    //
    for I in 1..=N {
        V_ZERO[I] = 0.0;
    }

    //
    // An index vector, whose components are their indices.
    //
    for I in 1..=N {
        V_INDX[I] = (I as f64);
    }

    //
    // A random vector, whose components are
    // uniformly distributed on the interval [-1.0D0,+1.0D0].
    //
    SEED = SEED0;

    for I in 1..=N {
        V_RAN[I] = testutil::T_RANDD(-1.0, 1.0, &mut SEED, ctx)?;
    }

    //
    // Cases to test VZEROG
    //
    testutil::TCASE(b"Test VZEROG with a zero vector", ctx)?;

    VZERO = spicelib::VZEROG(V_ZERO.as_slice(), N);

    testutil::CHCKSL(b"VZERO", VZERO, true, OK, ctx)?;

    testutil::TCASE(b"Test VZEROG with an index vector", ctx)?;

    VZERO = spicelib::VZEROG(V_INDX.as_slice(), N);

    testutil::CHCKSL(b"VZERO", VZERO, false, OK, ctx)?;

    testutil::TCASE(b"Test VZEROG with a zero dimension", ctx)?;

    VZERO = spicelib::VZEROG(V_ZERO.as_slice(), 0);

    testutil::CHCKSL(b"VZERO", VZERO, false, OK, ctx)?;

    testutil::TCASE(b"Test VZEROG with a negative dimension", ctx)?;

    VZERO = spicelib::VZEROG(V_ZERO.as_slice(), -N);

    testutil::CHCKSL(b"VZERO", VZERO, false, OK, ctx)?;

    //
    // Cases to test VEQUG
    //
    testutil::TCASE(b"Test VEQUG with a zero vector", ctx)?;

    spicelib::VEQUG(V_ZERO.as_slice(), N, V_OUT.as_slice_mut());

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_ZERO.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(b"Test VEQUG with an index vector", ctx)?;

    spicelib::VEQUG(V_INDX.as_slice(), N, V_OUT.as_slice_mut());

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_INDX.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(b"Test VEQUG with a random vector", ctx)?;

    spicelib::VEQUG(V_RAN.as_slice(), N, V_OUT.as_slice_mut());

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_RAN.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    //
    // Cases to test VADDG
    //
    testutil::TCASE(
        b"Test VADDG by adding a zero vector and a random vector",
        ctx,
    )?;

    spicelib::VADDG(V_ZERO.as_slice(), V_RAN.as_slice(), N, V_OUT.as_slice_mut());

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_RAN.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Test VADDG by adding an index vector and a random vector",
        ctx,
    )?;

    spicelib::VADDG(V_INDX.as_slice(), V_RAN.as_slice(), N, V_OUT.as_slice_mut());

    for I in 1..=N {
        V_EXPT[I] = (V_INDX[I] + V_RAN[I]);
    }

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_EXPT.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    //
    // Cases to test VSUBG
    //
    testutil::TCASE(
        b"Test VSUBG by subtracting a zero vector from a random vector",
        ctx,
    )?;

    spicelib::VSUBG(V_RAN.as_slice(), V_ZERO.as_slice(), N, V_OUT.as_slice_mut());

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_RAN.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Test VADDG by subtracting an index vector from a random vector",
        ctx,
    )?;

    spicelib::VSUBG(V_RAN.as_slice(), V_INDX.as_slice(), N, V_OUT.as_slice_mut());

    for I in 1..=N {
        V_EXPT[I] = (V_RAN[I] - V_INDX[I]);
    }

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_EXPT.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    //
    // Cases to test VDOTG
    //
    testutil::TCASE(b"Test VDOTG with a zero vector and a random vector", ctx)?;

    EVAL = spicelib::VDOTG(V_ZERO.as_slice(), V_RAN.as_slice(), N);

    EXPT = 0.0;

    testutil::CHCKSD(b"EVAL", EVAL, b"~", EXPT, 0.0, OK, ctx)?;

    testutil::TCASE(b"Test VDOTG with an index vector and a random vector", ctx)?;

    EVAL = spicelib::VDOTG(V_INDX.as_slice(), V_RAN.as_slice(), N);

    EXPT = 0.0;

    for I in 1..=N {
        EXPT = (EXPT + (V_INDX[I] * V_RAN[I]));
    }

    testutil::CHCKSD(b"EVAL", EVAL, b"~", EXPT, TINY, OK, ctx)?;

    //
    // Cases to test VNORMG
    //
    testutil::TCASE(b"Test VNORMG with a zero vector", ctx)?;

    EVAL = spicelib::VNORMG(V_ZERO.as_slice(), N);

    EXPT = 0.0;

    testutil::CHCKSD(b"EVAL", EVAL, b"~", EXPT, 0.0, OK, ctx)?;

    testutil::TCASE(b"Test VNORMG with an index vector", ctx)?;

    EVAL = spicelib::VNORMG(V_INDX.as_slice(), N);

    DUMMY = 0.0;

    for I in 1..=N {
        DUMMY = (DUMMY + (V_INDX[I] * V_INDX[I]));
    }

    EXPT = f64::sqrt(DUMMY);

    testutil::CHCKSD(b"EVAL", EVAL, b"~/", EXPT, TIGHT, OK, ctx)?;

    //
    // Cases to test UNORMG
    //
    testutil::TCASE(b"Test UNORMG with a zero vector", ctx)?;

    spicelib::UNORMG(V_ZERO.as_slice(), N, V_OUT.as_slice_mut(), &mut VECMAG);

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_ZERO.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::CHCKSD(b"VECMAG", VECMAG, b"~", 0.0, 0.0, OK, ctx)?;

    testutil::TCASE(b"Test UNORMG with a random vector", ctx)?;

    spicelib::UNORMG(V_RAN.as_slice(), N, V_OUT.as_slice_mut(), &mut VECMAG);

    EXPT = spicelib::VNORMG(V_RAN.as_slice(), N);

    testutil::CHCKSD(b"VECMAG", VECMAG, b"~", EXPT, 0.0, OK, ctx)?;

    EXPT = 1.0;

    DUMMY = spicelib::VNORMG(V_OUT.as_slice(), N);

    testutil::CHCKSD(b"DUMMY", DUMMY, b"~", EXPT, TIGHT, OK, ctx)?;

    spicelib::VSCLG(VECMAG, V_OUT.as_slice(), N, V_TMP.as_slice_mut());

    testutil::CHCKAD(
        b"V_TMP",
        V_TMP.as_slice(),
        b"~",
        V_RAN.as_slice(),
        N,
        TIGHT,
        OK,
        ctx,
    )?;

    //
    // Cases to test VHATG
    //
    testutil::TCASE(b"Test VHATG with a zero vector", ctx)?;

    spicelib::VHATG(V_ZERO.as_slice(), N, V_OUT.as_slice_mut());

    //
    // VHATG returns a zero vector for a zero vector input.
    //
    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_ZERO.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(b"Test VHATG with a random vector", ctx)?;

    spicelib::VHATG(V_RAN.as_slice(), N, V_OUT.as_slice_mut());

    EVAL = spicelib::VNORMG(V_OUT.as_slice(), N);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", 1.0, TIGHT, OK, ctx)?;

    //
    // Cases to test VSCLG
    //
    testutil::TCASE(b"Test VSCLG by scaling an index vector", ctx)?;

    SCALE = testutil::T_RANDD(-1.0, 1.0, &mut SEED, ctx)?;

    spicelib::VSCLG(SCALE, V_INDX.as_slice(), N, V_OUT.as_slice_mut());

    for I in 1..=N {
        V_EXPT[I] = (SCALE * V_INDX[I]);
    }

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_EXPT.as_slice(),
        N,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(b"Test VSCLG by scaling back to the index vector", ctx)?;

    SCALE = (1.0 / SCALE);

    spicelib::VSCLG(SCALE, V_OUT.as_slice(), N, V_TMP.as_slice_mut());

    testutil::CHCKAD(
        b"V_TMP",
        V_TMP.as_slice(),
        b"~",
        V_INDX.as_slice(),
        N,
        TIGHT,
        OK,
        ctx,
    )?;

    //
    // Cases to test VDISTG
    //
    testutil::TCASE(b"Test VDISTG using the same vector", ctx)?;

    EVAL = spicelib::VDISTG(V_INDX.as_slice(), V_INDX.as_slice(), N);

    //
    // Distance between same vectors should be zero.
    //
    testutil::CHCKSD(b"EVAL", EVAL, b"~", 0.0, 0.0, OK, ctx)?;

    testutil::TCASE(
        b"Test VDISTG using an index vector and a random vector",
        ctx,
    )?;

    EVAL = spicelib::VDISTG(V_INDX.as_slice(), V_RAN.as_slice(), N);

    spicelib::VSUBG(V_INDX.as_slice(), V_RAN.as_slice(), N, V_TMP.as_slice_mut());

    EXPT = spicelib::VNORMG(V_TMP.as_slice(), N);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", EXPT, TIGHT, OK, ctx)?;

    //
    // Cases to test VRELG
    //
    testutil::TCASE(b"Test VRELG using two zero vectors", ctx)?;

    EVAL = spicelib::VRELG(V_ZERO.as_slice(), V_ZERO.as_slice(), N);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", 0.0, 0.0, OK, ctx)?;

    testutil::TCASE(b"Test VRELG using an index vector and a random vector", ctx)?;

    EVAL = spicelib::VRELG(V_INDX.as_slice(), V_RAN.as_slice(), N);

    EXPT = (spicelib::VDISTG(V_INDX.as_slice(), V_RAN.as_slice(), N)
        / intrinsics::DMAX1(&[
            spicelib::VNORMG(V_INDX.as_slice(), N),
            spicelib::VNORMG(V_RAN.as_slice(), N),
        ]));

    testutil::CHCKSD(b"EVAL", EVAL, b"~", EXPT, 0.0, OK, ctx)?;

    //
    // Cases to test VSEPG
    //
    testutil::TCASE(
        b"Test VSEPG for the angle between a zero vector and a random vector",
        ctx,
    )?;

    EVAL = spicelib::VSEPG(V_ZERO.as_slice(), V_RAN.as_slice(), N, ctx);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", 0.0, 0.0, OK, ctx)?;

    testutil::TCASE(
        b"Test VSEPG for the angle between a random vector and a zero vector",
        ctx,
    )?;

    EVAL = spicelib::VSEPG(V_RAN.as_slice(), V_ZERO.as_slice(), N, ctx);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", 0.0, 0.0, OK, ctx)?;

    testutil::TCASE(b"Test VSEPG for the angle between two same vectors", ctx)?;

    EVAL = spicelib::VSEPG(V_INDX.as_slice(), V_INDX.as_slice(), N, ctx);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", 0.0, 0.0, OK, ctx)?;

    testutil::TCASE(
        b"Test VSEPG for the angle between a random vector and an index vector",
        ctx,
    )?;

    EVAL = spicelib::VSEPG(V_INDX.as_slice(), V_RAN.as_slice(), N, ctx);

    EXPT = f64::acos(
        (spicelib::VDOTG(V_INDX.as_slice(), V_RAN.as_slice(), N)
            / (spicelib::VNORMG(V_INDX.as_slice(), N) * spicelib::VNORMG(V_RAN.as_slice(), N))),
    );

    testutil::CHCKSD(b"EVAL", EVAL, b"~", EXPT, TIGHT, OK, ctx)?;

    //
    // Cases to test VLCOMG
    //
    testutil::TCASE(
        b"Test VLCOMG using an index vector and a random vector",
        ctx,
    )?;

    SCALE = testutil::T_RANDD(-1.0, 1.0, &mut SEED, ctx)?;
    DUMMY = testutil::T_RANDD(-1.0, 1.0, &mut SEED, ctx)?;

    spicelib::VLCOMG(
        N,
        SCALE,
        V_INDX.as_slice(),
        DUMMY,
        V_RAN.as_slice(),
        V_OUT.as_slice_mut(),
    );

    for I in 1..=N {
        V_EXPT[I] = ((SCALE * V_INDX[I]) + (DUMMY * V_RAN[I]));
    }

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_EXPT.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(b"Test VLCOMG using an zero vector and a random vector", ctx)?;

    SCALE = testutil::T_RANDD(-1.0, 1.0, &mut SEED, ctx)?;

    spicelib::VLCOMG(
        N,
        SCALE,
        V_ZERO.as_slice(),
        1.0,
        V_RAN.as_slice(),
        V_OUT.as_slice_mut(),
    );

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_RAN.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    //
    // Cases to test VPROJG
    //
    testutil::TCASE(
        b"Test VPROJG by projecting a random vector to a zero vector",
        ctx,
    )?;

    spicelib::VPROJG(V_RAN.as_slice(), V_ZERO.as_slice(), N, V_OUT.as_slice_mut());

    testutil::CHCKAD(
        b"V_OUT",
        V_OUT.as_slice(),
        b"~",
        V_ZERO.as_slice(),
        N,
        0.0,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Test VPROJG by projecting a random vector to an index vector",
        ctx,
    )?;

    spicelib::VPROJG(V_RAN.as_slice(), V_INDX.as_slice(), N, V_OUT.as_slice_mut());

    //
    // Compute V_TMP to be the unit vector along V_INDX.
    //
    spicelib::VHATG(V_INDX.as_slice(), N, V_TMP.as_slice_mut());

    //
    // Check ( V_RAN DOT V_TMP ) .EQ. ( V_OUT DOT V_TMP ).
    //
    DUMMY = spicelib::VDOTG(V_RAN.as_slice(), V_TMP.as_slice(), N);

    EVAL = spicelib::VDOTG(V_OUT.as_slice(), V_TMP.as_slice(), N);

    testutil::CHCKSD(b"EVAL", EVAL, b"~", DUMMY, TIGHT, OK, ctx)?;

    testutil::T_SUCCESS(OK, ctx);

    Ok(())
}