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

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

const MAXDEG: i32 = 15;
const TIGHT: f64 = 0.00000000000001;
const MEDIUM: f64 = 0.000000000001;

struct SaveVars {
    QID: StackArray<f64, 4>,
    QIDNEG: StackArray<f64, 4>,
    QI: StackArray<f64, 4>,
    QJ: StackArray<f64, 4>,
    QK: StackArray<f64, 4>,
}

impl SaveInit for SaveVars {
    fn new() -> Self {
        let mut QID = StackArray::<f64, 4>::new(0..=3);
        let mut QIDNEG = StackArray::<f64, 4>::new(0..=3);
        let mut QI = StackArray::<f64, 4>::new(0..=3);
        let mut QJ = StackArray::<f64, 4>::new(0..=3);
        let mut QK = StackArray::<f64, 4>::new(0..=3);

        {
            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();
            QIDNEG
                .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();
            QID.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)].into_iter();
            QI.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)].into_iter();
            QJ.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(1.0)].into_iter();
            QK.iter_mut()
                .for_each(|n| *n = clist.next().unwrap().into_f64());

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

        Self {
            QID,
            QIDNEG,
            QI,
            QJ,
            QK,
        }
    }
}

//$Procedure F_QUAT ( Quaternion routine tests )
pub fn F_QUAT(OK: &mut bool, ctx: &mut Context) -> f2rust_std::Result<()> {
    let save = ctx.get_vars::<SaveVars>();
    let save = &mut *save.borrow_mut();

    let mut ANGLE = StackArray::<f64, 3>::new(1..=3);
    let mut AV = StackArray::<f64, 3>::new(1..=3);
    let mut AVX = StackArray::<f64, 3>::new(1..=3);
    let mut DM = StackArray2D::<f64, 9>::new(1..=3, 1..=3);
    let mut DQ = StackArray::<f64, 4>::new(0..=3);
    let mut EXPAV = StackArray::<f64, 3>::new(1..=3);
    let mut M1 = StackArray2D::<f64, 9>::new(1..=3, 1..=3);
    let mut M2 = StackArray2D::<f64, 9>::new(1..=3, 1..=3);
    let mut MEXP = StackArray2D::<f64, 9>::new(1..=3, 1..=3);
    let mut MOUT = StackArray2D::<f64, 9>::new(1..=3, 1..=3);
    let mut Q = StackArray::<f64, 4>::new(0..=3);
    let mut Q1 = StackArray::<f64, 4>::new(0..=3);
    let mut Q2 = StackArray::<f64, 4>::new(0..=3);
    let mut QAV = StackArray::<f64, 4>::new(0..=3);
    let mut QEXP = StackArray::<f64, 4>::new(0..=3);
    let mut QOUT = StackArray::<f64, 4>::new(0..=3);
    let mut QTMP = StackArray::<f64, 4>::new(0..=3);
    let mut XTRANS = StackArray2D::<f64, 36>::new(1..=6, 1..=6);

    //
    // Test Utility Functions
    //

    //
    // SPICELIB Functions
    //

    //
    // Local Parameters
    //

    //
    // Local Variables
    //

    //
    // Saved variables
    //

    //
    // Initial values
    //

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

    //
    // QXQ tests follow:
    //
    testutil::TCASE(
        b"QXQ test:  Check compliance with  Hamilton\'s rules.  Test QI x QJ.",
        ctx,
    )?;

    spicelib::QXQ(save.QI.as_slice(), save.QJ.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"i*j",
        QOUT.as_slice(),
        b"~",
        save.QK.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Check compliance with Hamilton\'s rules.  Test QJ x QK.",
        ctx,
    )?;

    spicelib::QXQ(save.QJ.as_slice(), save.QK.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"j*k",
        QOUT.as_slice(),
        b"~",
        save.QI.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Check compliance with Hamilton\'s rules.  Test QK x QI.",
        ctx,
    )?;

    spicelib::QXQ(save.QK.as_slice(), save.QI.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"k*i",
        QOUT.as_slice(),
        b"~",
        save.QJ.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Check compliance with Hamilton\'s rules.  Test QI x QI.",
        ctx,
    )?;
    spicelib::QXQ(save.QI.as_slice(), save.QI.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"i*i",
        QOUT.as_slice(),
        b"~",
        save.QIDNEG.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Check compliance with Hamilton\'s rules.  Test QJ x QJ.",
        ctx,
    )?;

    spicelib::QXQ(save.QJ.as_slice(), save.QJ.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"j*j",
        QOUT.as_slice(),
        b"~",
        save.QIDNEG.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(
        b"Check compliance with Hamilton\'s rules.  Test QK x QK.",
        ctx,
    )?;

    spicelib::QXQ(save.QK.as_slice(), save.QK.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"k*k",
        QOUT.as_slice(),
        b"~",
        save.QIDNEG.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    QEXP[0] = 1.0;
    QEXP[1] = 2.0;
    QEXP[2] = 3.0;
    QEXP[3] = 4.0;

    testutil::TCASE(b"Check right-multiplication by the identity.", ctx)?;
    spicelib::QXQ(QEXP.as_slice(), save.QID.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"QEXP * 1",
        QOUT.as_slice(),
        b"~",
        QEXP.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    testutil::TCASE(b"Check left-multiplication by the identity.", ctx)?;
    spicelib::QXQ(save.QID.as_slice(), QEXP.as_slice(), QOUT.as_slice_mut());
    testutil::CHCKAD(
        b"1 * QEXP",
        QOUT.as_slice(),
        b"~",
        QEXP.as_slice(),
        4,
        TIGHT,
        OK,
        ctx,
    )?;

    //
    // Try a more complex case:  multiply two rotation matrices
    // via quaternion multiplication.
    //
    testutil::TCASE(
        b"Multiply two rotations via quaternion multiplication.",
        ctx,
    )?;

    spicelib::EUL2M(
        (spicelib::RPD(ctx) * 20.0),
        (spicelib::RPD(ctx) * 10.0),
        (spicelib::RPD(ctx) * 70.0),
        3,
        1,
        3,
        M1.as_slice_mut(),
        ctx,
    )?;

    spicelib::EUL2M(
        (spicelib::RPD(ctx) * -20.0),
        (spicelib::RPD(ctx) * 30.0),
        (spicelib::RPD(ctx) * -10.0),
        3,
        1,
        3,
        M2.as_slice_mut(),
        ctx,
    )?;

    spicelib::M2Q(M1.as_slice(), Q1.as_slice_mut(), ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::M2Q(M2.as_slice(), Q2.as_slice_mut(), ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::QXQ(Q1.as_slice(), Q2.as_slice(), QOUT.as_slice_mut());
    spicelib::Q2M(QOUT.as_slice(), MOUT.as_slice_mut());

    spicelib::MXM(M1.as_slice(), M2.as_slice(), MEXP.as_slice_mut());

    testutil::CHCKAD(
        b"MOUT",
        MOUT.as_slice(),
        b"~",
        MEXP.as_slice(),
        9,
        0.000000000001,
        OK,
        ctx,
    )?;

    //
    // QDQ2AV tests follow:
    //
    testutil::TCASE(b"Produce quaternion and derivative from Euler angles and a.v.  Recover a.v. from QDQ2AV; compare to original a.v.", ctx)?;

    //
    // Start with a known rotation and angular velocity.  Find
    // the quaternion and quaternion derivative.  The latter is
    // computed from
    //
    //                    *
    //     AV  =   -2  * Q  * DQ
    //
    //     DQ  =  -1/2 * Q  * AV
    //

    ANGLE[1] = -(20.0 * spicelib::RPD(ctx));
    ANGLE[2] = (50.0 * spicelib::RPD(ctx));
    ANGLE[3] = -(60.0 * spicelib::RPD(ctx));

    spicelib::EUL2M(
        ANGLE[3],
        ANGLE[2],
        ANGLE[1],
        3,
        1,
        3,
        M1.as_slice_mut(),
        ctx,
    )?;

    spicelib::M2Q(M1.as_slice(), Q.as_slice_mut(), ctx)?;

    EXPAV[1] = 1.0;
    EXPAV[2] = 2.0;
    EXPAV[3] = 3.0;

    //
    // Form the quaternion derivative.
    //
    QAV[0] = 0.0;
    spicelib::VEQU(EXPAV.as_slice(), QAV.subarray_mut(1));

    spicelib::QXQ(Q.as_slice(), QAV.as_slice(), DQ.as_slice_mut());

    spicelib::VSCLG(-0.5, DQ.as_slice(), 4, QTMP.as_slice_mut());
    spicelib::MOVED(QTMP.as_slice(), 4, DQ.as_slice_mut());

    //
    // Recover angular velocity from Q and DQ.
    //
    spicelib::QDQ2AV(Q.as_slice(), DQ.as_slice(), AV.as_slice_mut());

    //
    // Do a consistency check against the original a.v.  This is
    // an intermediate check; it demonstrates invertibility but
    // not correctness of our formulas.
    //
    testutil::CHCKAD(
        b"AV from Q and DQ",
        AV.as_slice(),
        b"~",
        EXPAV.as_slice(),
        3,
        0.000000000001,
        OK,
        ctx,
    )?;

    //
    // Convert Q back to a rotation matrix.
    //
    spicelib::Q2M(Q.as_slice(), M1.as_slice_mut());

    testutil::TCASE(b"Map a quaternion and derivative to angular velocity via a transformation matrix and xf2rav.  Compare to result from QDQ2AV.", ctx)?;
    //
    // Convert Q and DQ to a rotation derivative matrix.  This
    // somewhat messy procedure is based on differentiating the
    // formula for deriving a rotation from a quaternion, then
    // substituting components of Q and DQ into the derivative
    // formula.
    //
    DM[[1, 1]] = -(4.0 * ((Q[2] * DQ[2]) + (Q[3] * DQ[3])));

    DM[[1, 2]] = (2.0 * ((((Q[1] * DQ[2]) + (Q[2] * DQ[1])) - (Q[0] * DQ[3])) - (Q[3] * DQ[0])));

    DM[[1, 3]] = (2.0 * ((((Q[1] * DQ[3]) + (Q[3] * DQ[1])) + (Q[0] * DQ[2])) + (Q[2] * DQ[0])));

    DM[[2, 1]] = (2.0 * ((((Q[1] * DQ[2]) + (Q[2] * DQ[1])) + (Q[0] * DQ[3])) + (Q[3] * DQ[0])));

    DM[[2, 2]] = -(4.0 * ((Q[1] * DQ[1]) + (Q[3] * DQ[3])));

    DM[[2, 3]] = (2.0 * ((((Q[2] * DQ[3]) + (Q[3] * DQ[2])) - (Q[0] * DQ[1])) - (Q[1] * DQ[0])));

    DM[[3, 1]] = (2.0 * ((((Q[3] * DQ[1]) + (Q[1] * DQ[3])) - (Q[0] * DQ[2])) - (Q[2] * DQ[0])));

    DM[[3, 2]] = (2.0 * ((((Q[2] * DQ[3]) + (Q[3] * DQ[2])) + (Q[0] * DQ[1])) + (Q[1] * DQ[0])));

    DM[[3, 3]] = -(4.0 * ((Q[1] * DQ[1]) + (Q[2] * DQ[2])));

    //
    // Form the state transformation matrix corresponding to M1
    // and DM.
    //
    spicelib::CLEARD(36, XTRANS.as_slice_mut());

    //
    // Upper left block:
    //
    for I in 1..=3 {
        for J in 1..=3 {
            XTRANS[[I, J]] = M1[[I, J]];
        }
    }

    //
    // Lower right block:
    //
    for I in 1..=3 {
        for J in 1..=3 {
            XTRANS[[(3 + I), (3 + J)]] = M1[[I, J]];
        }
    }

    //
    // Lower left block:
    //
    for I in 1..=3 {
        for J in 1..=3 {
            XTRANS[[(3 + I), J]] = DM[[I, J]];
        }
    }

    spicelib::XF2RAV(XTRANS.as_slice(), MOUT.as_slice_mut(), AVX.as_slice_mut());

    //
    // Compare the angular velocity obtained from the state
    // transformation with that from QDQ2AV.
    //
    testutil::CHCKAD(
        b"AV from Q and DQ",
        AV.as_slice(),
        b"~",
        AVX.as_slice(),
        3,
        0.000000000001,
        OK,
        ctx,
    )?;

    testutil::T_SUCCESS(OK, ctx);
    Ok(())
}