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
//
// GENERATED FILE
//

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

const LNSIZE: i32 = 255;
const NMLPOS: i32 = 1;
const NSIMPL: i32 = 4;
const NUMCAS: i32 = 200;
const UBPL: i32 = 4;
const MAGTOL: f64 = 0.00000000000001;
const TIGHT: f64 = 0.000000000001;
const VTIGHT: f64 = 0.00000000000001;

struct SaveVars {
    TITLE: Vec<u8>,
    C1: f64,
    C2: f64,
    C3: f64,
    CONST1: f64,
    CONST2: f64,
    CRIT: f64,
    EXPINV: StackArray2D<f64, 12>,
    INVPRJ: StackArray<f64, 3>,
    NORM1: StackArray<f64, 3>,
    NORM2: StackArray<f64, 3>,
    PLANE1: StackArray<f64, 4>,
    PLANE2: StackArray<f64, 4>,
    POINT: StackArray<f64, 3>,
    PRJ: StackArray<f64, 3>,
    PRJ2: StackArray<f64, 3>,
    SCALE: f64,
    SMPC1: StackArray<f64, 4>,
    SMPC2: StackArray<f64, 4>,
    SMPNM1: StackArray2D<f64, 12>,
    SMPNM2: StackArray2D<f64, 12>,
    SMPPRJ: StackArray2D<f64, 12>,
    V1: StackArray<f64, 3>,
    V2: StackArray<f64, 3>,
    SEED: i32,
    EXPFND: StackArray<bool, 4>,
    FOUND: bool,
}

impl SaveInit for SaveVars {
    fn new() -> Self {
        let mut TITLE = vec![b' '; LNSIZE as usize];
        let mut C1: f64 = 0.0;
        let mut C2: f64 = 0.0;
        let mut C3: f64 = 0.0;
        let mut CONST1: f64 = 0.0;
        let mut CONST2: f64 = 0.0;
        let mut CRIT: f64 = 0.0;
        let mut EXPINV = StackArray2D::<f64, 12>::new(1..=3, 1..=NSIMPL);
        let mut INVPRJ = StackArray::<f64, 3>::new(1..=3);
        let mut NORM1 = StackArray::<f64, 3>::new(1..=3);
        let mut NORM2 = StackArray::<f64, 3>::new(1..=3);
        let mut PLANE1 = StackArray::<f64, 4>::new(1..=UBPL);
        let mut PLANE2 = StackArray::<f64, 4>::new(1..=UBPL);
        let mut POINT = StackArray::<f64, 3>::new(1..=3);
        let mut PRJ = StackArray::<f64, 3>::new(1..=3);
        let mut PRJ2 = StackArray::<f64, 3>::new(1..=3);
        let mut SCALE: f64 = 0.0;
        let mut SMPC1 = StackArray::<f64, 4>::new(1..=NSIMPL);
        let mut SMPC2 = StackArray::<f64, 4>::new(1..=NSIMPL);
        let mut SMPNM1 = StackArray2D::<f64, 12>::new(1..=3, 1..=NSIMPL);
        let mut SMPNM2 = StackArray2D::<f64, 12>::new(1..=3, 1..=NSIMPL);
        let mut SMPPRJ = StackArray2D::<f64, 12>::new(1..=3, 1..=NSIMPL);
        let mut V1 = StackArray::<f64, 3>::new(1..=3);
        let mut V2 = StackArray::<f64, 3>::new(1..=3);
        let mut SEED: i32 = 0;
        let mut EXPFND = StackArray::<bool, 4>::new(1..=NSIMPL);
        let mut FOUND: bool = false;

        C1 = 10.0;
        C2 = 20.0;
        C3 = 1.0;
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::D(0.0),
                Val::D(1.0),
                Val::D(1.0),
                Val::D(0.0),
                Val::D(1.0),
                Val::D(1.0),
                Val::D(-1.0),
                Val::D(-2.0),
                Val::D(-3.0),
                Val::D(-4.0),
                Val::D(-5.0),
                Val::D(-6.0),
            ]
            .into_iter();
            EXPINV
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [Val::D(0.0), Val::D(0.0), Val::D(0.0), Val::D(0.0)].into_iter();
            SMPC1
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [Val::D(1.0), Val::D(0.0), Val::D(0.0), Val::D(0.0)].into_iter();
            SMPC2
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::D(0.0),
                Val::D(0.0),
                Val::D(1.0),
                Val::D(0.0),
                Val::D(0.0),
                Val::D(1.0),
                Val::D(0.0),
                Val::D(0.0),
                Val::D(1.0),
                Val::D(0.0),
                Val::D(0.0),
                Val::D(1.0),
            ]
            .into_iter();
            SMPNM1
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::D(0.0),
                Val::D(0.0),
                Val::D(1.0),
                Val::D(0.0),
                Val::D(-1.0),
                Val::D(1.0),
                Val::D(0.0),
                Val::D(-1.0),
                Val::D(0.0),
                Val::D(0.0),
                Val::D(-100000000.0),
                Val::D(1.0),
            ]
            .into_iter();
            SMPNM2
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
    Val::D(0.0),
    Val::D(1.0),
    Val::D(0.0),
    Val::D(0.0),
    Val::D(1.0),
    Val::D(0.0),
    Val::D(0.0),
    Val::D(1.0),
    Val::D(0.0),
    Val::D(0.0),
    Val::D(100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.0),
    Val::D(0.0),
  ].into_iter();
            SMPPRJ
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [Val::L(true), Val::L(true), Val::L(false), Val::L(false)].into_iter();
            EXPFND
                .iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_bool());

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }

        Self {
            TITLE,
            C1,
            C2,
            C3,
            CONST1,
            CONST2,
            CRIT,
            EXPINV,
            INVPRJ,
            NORM1,
            NORM2,
            PLANE1,
            PLANE2,
            POINT,
            PRJ,
            PRJ2,
            SCALE,
            SMPC1,
            SMPC2,
            SMPNM1,
            SMPNM2,
            SMPPRJ,
            V1,
            V2,
            SEED,
            EXPFND,
            FOUND,
        }
    }
}

//$Procedure F_PRJP ( Test wrappers for plane projection routines )
pub fn F_PRJP(OK: &mut bool, ctx: &mut Context) -> f2rust_std::Result<()> {
    let save = ctx.get_vars::<SaveVars>();
    let save = &mut *save.borrow_mut();

    //
    // SPICELIB functions
    //

    //
    // Test utility functions
    //

    //
    // Local Parameters
    //

    //
    // Local Variables
    //

    //
    // Saved variables
    //

    //
    // Initial values
    //

    //
    // Open the test family.
    //
    testutil::TOPEN(b"F_PRJP", ctx)?;

    //*****************************************************************
    //
    //     Normal cases
    //
    //*****************************************************************

    //
    // Cases 1:NSIMPL
    //
    for I in 1..=NSIMPL {
        //
        // --- Case: ------------------------------------------------------
        //
        fstr::assign(&mut save.TITLE, b"Simple case #");
        spicelib::REPMI(&save.TITLE.to_vec(), b"#", I, &mut save.TITLE, ctx);
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        testutil::TCASE(&save.TITLE, ctx)?;
        //
        // Create two planes.
        //
        spicelib::NVC2PL(
            save.SMPNM1.subarray([1, I]),
            save.SMPC1[I],
            save.PLANE1.as_slice_mut(),
            ctx,
        )?;
        testutil::CHCKXC(false, b" ", OK, ctx)?;
        spicelib::NVC2PL(
            save.SMPNM2.subarray([1, I]),
            save.SMPC2[I],
            save.PLANE2.as_slice_mut(),
            ctx,
        )?;
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        if !save.EXPFND[I] {
            //
            // This is a singular case.
            //
            // Set the output vector to something recognizable, so we can
            // make sure it's unchanged when no inverse is found.
            //
            spicelib::VEQU(save.EXPINV.subarray([1, I]), save.INVPRJ.as_slice_mut());
        }

        spicelib::VPRJPI(
            save.SMPPRJ.subarray([1, I]),
            save.PLANE1.as_slice(),
            save.PLANE2.as_slice(),
            save.INVPRJ.as_slice_mut(),
            &mut save.FOUND,
            ctx,
        )?;
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        testutil::CHCKSL(b"FOUND", save.FOUND, save.EXPFND[I], OK, ctx)?;

        testutil::CHCKAD(
            b"INVPRJ",
            save.INVPRJ.as_slice(),
            b"~/",
            save.EXPINV.subarray([1, I]),
            3,
            VTIGHT,
            OK,
            ctx,
        )?;
    }

    //
    // Random cases 1:NUMCAS
    //

    //
    // Set initial random number seed.
    //
    save.SEED = -1;

    for I in 1..=NUMCAS {
        //
        // --- Case: ------------------------------------------------------
        //
        fstr::assign(
            &mut save.TITLE,
            b"Test VPRJP and VPRJPI using random planes, case #",
        );
        spicelib::REPMI(&save.TITLE.to_vec(), b"#", I, &mut save.TITLE, ctx);

        testutil::TCASE(&save.TITLE, ctx)?;

        //
        // Create a pair of random planes using random scale, normal,
        // and constant.
        //
        save.SCALE = f64::powf(10.0, testutil::T_RANDD(30.0, 30.0, &mut save.SEED, ctx)?);

        save.CONST1 = (save.SCALE * testutil::T_RANDD(-100.0, 100.0, &mut save.SEED, ctx)?);
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        save.CONST2 = (save.SCALE * testutil::T_RANDD(-100.0, 100.0, &mut save.SEED, ctx)?);
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        for J in 1..=3 {
            save.NORM1[J] = testutil::T_RANDD(-100.0, 100.0, &mut save.SEED, ctx)?;
            testutil::CHCKXC(false, b" ", OK, ctx)?;

            save.NORM2[J] = testutil::T_RANDD(-100.0, 100.0, &mut save.SEED, ctx)?;
            testutil::CHCKXC(false, b" ", OK, ctx)?;
        }

        spicelib::VHATIP(save.NORM1.as_slice_mut());
        spicelib::VHATIP(save.NORM2.as_slice_mut());

        //
        // Find a point in the projection plane. Make up a new point;
        // this one will be the projection point.
        //
        // The reason for picking a new point is that the one returned
        // by PL2PSV is distinguished: it's a scalar multiple of the
        // plane's normal vector.
        //
        spicelib::PL2PSV(
            save.PLANE1.as_slice(),
            save.POINT.as_slice_mut(),
            save.V1.as_slice_mut(),
            save.V2.as_slice_mut(),
        );
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        spicelib::VLCOM3(
            (save.C1 * save.SCALE),
            save.V1.as_slice(),
            (save.C2 * save.SCALE),
            save.V2.as_slice(),
            save.C3,
            save.POINT.as_slice(),
            save.PRJ.as_slice_mut(),
        );
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        //
        // Find the inverse projection of prj. If it is found, project it
        // back to plane1 and see how close to the original point we get.
        //
        spicelib::VPRJPI(
            save.PRJ.as_slice(),
            save.PLANE1.as_slice(),
            save.PLANE2.as_slice(),
            save.INVPRJ.as_slice_mut(),
            &mut save.FOUND,
            ctx,
        )?;
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        if !save.FOUND {
            testutil::TSTMSG(b"#", b"Inverse projection not found. Normal of first plane is (#, #, #). Constant of first plane is #. Normal of second plane is (#, #, #). Constant of second plane is #. Inner product of the normal vectors is #.", ctx);

            testutil::TSTMSD(save.NORM1[1], ctx);
            testutil::TSTMSD(save.NORM1[2], ctx);
            testutil::TSTMSD(save.NORM1[3], ctx);
            testutil::TSTMSD(save.CONST1, ctx);
            testutil::TSTMSD(save.NORM2[1], ctx);
            testutil::TSTMSD(save.NORM2[2], ctx);
            testutil::TSTMSD(save.NORM2[3], ctx);
            testutil::TSTMSD(save.CONST2, ctx);
            testutil::TSTMSD(
                spicelib::VDOT(save.NORM1.as_slice(), save.NORM2.as_slice()),
                ctx,
            );

            testutil::CHCKSL(b"FOUND", save.FOUND, true, OK, ctx)?;
        } else {
            spicelib::VPRJP(
                save.INVPRJ.as_slice(),
                save.PLANE1.as_slice(),
                save.PRJ2.as_slice_mut(),
                ctx,
            )?;
            testutil::CHCKXC(false, b" ", OK, ctx)?;

            save.CRIT = (spicelib::VDIST(save.PRJ2.as_slice(), save.PRJ.as_slice()) / save.SCALE);

            if (f64::abs(save.CRIT) > TIGHT) {
                testutil::TSTMSG(b"#", b"Projection comparison failed. Normal of first plane is (#, #, #). Constant of first plane is #. Normal of second plane is (#, #, #). Constant of second plane is #. Inner product of the normal vectors is #. Scaled distance between original point and final point is #.", ctx);

                testutil::TSTMSD(save.NORM1[1], ctx);
                testutil::TSTMSD(save.NORM1[2], ctx);
                testutil::TSTMSD(save.NORM1[3], ctx);
                testutil::TSTMSD(save.CONST1, ctx);
                testutil::TSTMSD(save.NORM2[1], ctx);
                testutil::TSTMSD(save.NORM2[2], ctx);
                testutil::TSTMSD(save.NORM2[3], ctx);
                testutil::TSTMSD(save.CONST2, ctx);
                testutil::TSTMSD(
                    spicelib::VDOT(save.NORM1.as_slice(), save.NORM2.as_slice()),
                    ctx,
                );
                testutil::TSTMSD(save.CRIT, ctx);

                testutil::CHCKSD(
                    b"scaled distance between prj and prj2",
                    f64::abs(save.CRIT),
                    b"<=",
                    TIGHT,
                    0.0,
                    OK,
                    ctx,
                )?;
            }
        }
    }

    //*****************************************************************
    //
    //     Error cases
    //
    //*****************************************************************

    //
    // --- Case: ------------------------------------------------------
    //
    testutil::TCASE(b"Pass an invalid plane to VPRJP: this plane has normal vector length different from 1 by more than 1.e-14.", ctx)?;

    spicelib::CLEARD(UBPL, save.PLANE1.as_slice_mut());

    spicelib::VPACK(
        (1.0 + (1.1 * MAGTOL)),
        0.0,
        0.0,
        save.PLANE1.subarray_mut(NMLPOS),
    );

    spicelib::CLEARD(3, save.V1.as_slice_mut());

    spicelib::VPRJP(
        save.V1.as_slice(),
        save.PLANE1.as_slice(),
        save.PRJ.as_slice_mut(),
        ctx,
    )?;
    testutil::CHCKXC(true, b"SPICE(NONUNITNORMAL)", OK, ctx)?;

    //
    // --- Case: ------------------------------------------------------
    //
    testutil::TCASE(b"Pass an invalid projection plane to VPRJPI: this plane has normal vector length different from 1 by more than 1.e-14.", ctx)?;

    spicelib::CLEARD(UBPL, save.PLANE1.as_slice_mut());

    spicelib::VPACK(
        (1.0 + (1.1 * MAGTOL)),
        0.0,
        0.0,
        save.PLANE1.subarray_mut(NMLPOS),
    );

    spicelib::CLEARD(UBPL, save.PLANE2.as_slice_mut());

    spicelib::VPACK(0.0, 0.0, 1.0, save.PLANE2.subarray_mut(NMLPOS));

    spicelib::CLEARD(3, save.V1.as_slice_mut());

    spicelib::VPRJPI(
        save.V1.as_slice(),
        save.PLANE1.as_slice(),
        save.PLANE2.as_slice(),
        save.INVPRJ.as_slice_mut(),
        &mut save.FOUND,
        ctx,
    )?;
    testutil::CHCKXC(true, b"SPICE(NONUNITNORMAL)", OK, ctx)?;

    //
    // --- Case: ------------------------------------------------------
    //
    testutil::TCASE(b"Pass an invalid inverse projection plane to VPRJPI: this plane has normal vector length different from 1 by more than 1.e-14.", ctx)?;

    spicelib::CLEARD(UBPL, save.PLANE1.as_slice_mut());
    spicelib::VPACK(0.0, 0.0, 1.0, save.PLANE1.subarray_mut(NMLPOS));

    spicelib::CLEARD(UBPL, save.PLANE2.as_slice_mut());
    spicelib::VPACK(
        (1.0 + (1.1 * MAGTOL)),
        0.0,
        0.0,
        save.PLANE2.subarray_mut(NMLPOS),
    );

    spicelib::CLEARD(3, save.V1.as_slice_mut());

    spicelib::VPRJPI(
        save.V1.as_slice(),
        save.PLANE1.as_slice(),
        save.PLANE2.as_slice(),
        save.INVPRJ.as_slice_mut(),
        &mut save.FOUND,
        ctx,
    )?;
    testutil::CHCKXC(true, b"SPICE(NONUNITNORMAL)", OK, ctx)?;

    //
    // Close out the test family.
    //
    testutil::T_SUCCESS(OK, ctx);
    Ok(())
}