molar 1.4.0

Molar is a rust library for analysis of MD trajectories and molecular modeling
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
596
597
598
599
600
601
602
603
use crate::prelude::*;
use std::{
    fs::File,
    io::{self, BufReader, BufWriter, Read, Seek, SeekFrom, Write},
    path::Path,
};
use thiserror::Error;

use super::{FileFormatError, FileFormatHandler, SaveState};

//=============================== Error type ===============================

#[derive(Error, Debug)]
pub enum TrrHandlerError {
    #[error("invalid TRR magic number {0}")]
    MagicNumber(i32),

    #[error("invalid TRR header")]
    Header,

    #[error("TRR seek to frame {0} failed")]
    SeekFrame(usize, #[source] io::Error),

    #[error("TRR seek to time {0} failed")]
    SeekTime(f32, #[source] io::Error),

    #[error("invalid periodic box")]
    Pbc(#[from] PeriodicBoxError),

    #[error("unexpected io error")]
    Io(#[from] io::Error),
}

//=============================== XDR primitives ===========================

fn xdr_read_i32(r: &mut impl Read) -> io::Result<i32> {
    let mut buf = [0u8; 4];
    r.read_exact(&mut buf)?;
    Ok(i32::from_be_bytes(buf))
}

fn xdr_read_f32(r: &mut impl Read) -> io::Result<f32> {
    let mut buf = [0u8; 4];
    r.read_exact(&mut buf)?;
    Ok(f32::from_bits(u32::from_be_bytes(buf)))
}

fn xdr_read_f64(r: &mut impl Read) -> io::Result<f64> {
    let mut buf = [0u8; 8];
    r.read_exact(&mut buf)?;
    Ok(f64::from_bits(u64::from_be_bytes(buf)))
}

fn xdr_write_i32(w: &mut impl Write, v: i32) -> io::Result<()> {
    w.write_all(&v.to_be_bytes())
}

fn xdr_write_f32(w: &mut impl Write, v: f32) -> io::Result<()> {
    w.write_all(&v.to_bits().to_be_bytes())
}

fn xdr_skip(r: &mut impl Read, n_bytes: usize) -> io::Result<()> {
    let mut buf = vec![0u8; n_bytes];
    r.read_exact(&mut buf)
}

/// Read `n` XDR-encoded 3D vectors (velocities or forces). Returns `Vec<Vel>`.
/// Since `Vel` and `Force` are both `Vector3<f32>` the same function serves both.
fn read_xvf(r: &mut impl Read, n: usize, b_double: bool) -> io::Result<Vec<Vel>> {
    if b_double {
        (0..n)
            .map(|_| {
                let x = xdr_read_f64(r)? as f32;
                let y = xdr_read_f64(r)? as f32;
                let z = xdr_read_f64(r)? as f32;
                Ok(Vel::new(x, y, z))
            })
            .collect()
    } else {
        (0..n)
            .map(|_| {
                let x = xdr_read_f32(r)?;
                let y = xdr_read_f32(r)?;
                let z = xdr_read_f32(r)?;
                Ok(Vel::new(x, y, z))
            })
            .collect()
    }
}

//=============================== Header struct ============================

const GROMACS_MAGIC: i32 = 1993;
const TRR_VERSION: &str = "GMX_trn_file";

struct TrrHeader {
    box_size: i32,
    vir_size: i32,
    pres_size: i32,
    x_size: i32,
    v_size: i32,
    f_size: i32,
    natoms: i32,
    step: i32,
    time: f32,
    b_double: bool,
}

fn read_trr_header(r: &mut impl Read) -> Result<TrrHeader, TrrHandlerError> {
    // magic
    let magic = xdr_read_i32(r)?;
    if magic != GROMACS_MAGIC {
        return Err(TrrHandlerError::MagicNumber(magic));
    }

    // slen (= 13)
    let _slen = xdr_read_i32(r)?;

    // XDR string: i32 length (12) + 12 bytes "GMX_trn_file"
    let str_len = xdr_read_i32(r)? as usize;
    // XDR strings are padded to 4-byte boundary
    let padded = (str_len + 3) & !3;
    let mut str_buf = vec![0u8; padded];
    r.read_exact(&mut str_buf)?;
    let version = std::str::from_utf8(&str_buf[..str_len])
        .map_err(|_| TrrHandlerError::Header)?;
    if version != TRR_VERSION {
        return Err(TrrHandlerError::Header);
    }

    let ir_size = xdr_read_i32(r)?;
    let e_size = xdr_read_i32(r)?;
    let box_size = xdr_read_i32(r)?;
    let vir_size = xdr_read_i32(r)?;
    let pres_size = xdr_read_i32(r)?;
    let top_size = xdr_read_i32(r)?;
    let sym_size = xdr_read_i32(r)?;
    let x_size = xdr_read_i32(r)?;
    let v_size = xdr_read_i32(r)?;
    let f_size = xdr_read_i32(r)?;
    let natoms = xdr_read_i32(r)?;
    let step = xdr_read_i32(r)?;
    let _nre = xdr_read_i32(r)?;

    // Detect precision: if any size == natoms*3*8 or box == 9*8, it's double
    let n3 = natoms as i32 * 3;
    let b_double = (box_size == 72)
        || (x_size == n3 * 8)
        || (v_size != 0 && v_size == n3 * 8)
        || (f_size != 0 && f_size == n3 * 8);

    let elem_size = if b_double { 8 } else { 4 };

    // time and lambda
    let time = if b_double {
        xdr_read_f64(r)? as f32
    } else {
        xdr_read_f32(r)?
    };
    // lambda (skip)
    xdr_skip(r, elem_size)?;

    // Validate sizes (ignore ir_size, e_size, top_size, sym_size — should all be 0)
    let _ = (ir_size, e_size, top_size, sym_size);

    Ok(TrrHeader {
        box_size,
        vir_size,
        pres_size,
        x_size,
        v_size,
        f_size,
        natoms,
        step,
        time,
        b_double,
    })
}

fn write_trr_header(w: &mut impl Write, h: &TrrHeader) -> Result<(), TrrHandlerError> {
    xdr_write_i32(w, GROMACS_MAGIC)?;

    // slen = strlen("GMX_trn_file") + 1 = 13
    xdr_write_i32(w, 13)?;

    // XDR string: length field (12) + 12 bytes (no padding needed since 12 % 4 == 0)
    xdr_write_i32(w, TRR_VERSION.len() as i32)?;
    w.write_all(TRR_VERSION.as_bytes())?;

    xdr_write_i32(w, 0)?; // ir_size
    xdr_write_i32(w, 0)?; // e_size
    xdr_write_i32(w, h.box_size)?;
    xdr_write_i32(w, 0)?; // vir_size
    xdr_write_i32(w, 0)?; // pres_size
    xdr_write_i32(w, 0)?; // top_size
    xdr_write_i32(w, 0)?; // sym_size
    xdr_write_i32(w, h.x_size)?;
    xdr_write_i32(w, h.v_size)?;
    xdr_write_i32(w, h.f_size)?;
    xdr_write_i32(w, h.natoms)?;
    xdr_write_i32(w, h.step)?;
    xdr_write_i32(w, 0)?; // nre

    // time and lambda (always f32 when writing)
    xdr_write_f32(w, h.time)?;
    xdr_write_f32(w, 0.0)?; // lambda

    Ok(())
}

/// Compute data size for a single frame (without reading data).
/// Returns None if we can't determine size (shouldn't happen for well-formed files).
fn frame_data_size(h: &TrrHeader) -> usize {
    let elem = if h.b_double { 8usize } else { 4usize };
    let mut size = 0usize;
    if h.box_size != 0 { size += 9 * elem; }
    if h.vir_size != 0 { size += 9 * elem; }
    if h.pres_size != 0 { size += 9 * elem; }
    let n3 = h.natoms as usize * 3;
    if h.x_size != 0 { size += n3 * elem; }
    if h.v_size != 0 { size += n3 * elem; }
    if h.f_size != 0 { size += n3 * elem; }
    size
}

//=============================== Structs ==================================

pub(crate) struct TrrReader {
    file: BufReader<File>,
    cur_frame: usize,
}

pub(crate) struct TrrWriter {
    file: BufWriter<File>,
    cur_frame: usize,
    natoms: Option<usize>,
}

pub enum TrrFileHandler {
    Reader(TrrReader),
    Writer(TrrWriter),
}

//=============================== Helper to read a frame's data ============

/// Read a frame's data from current position (after header has been read).
/// The bool flags control which fields are populated; unwanted data is skipped at the I/O level.
fn read_frame_data(
    r: &mut impl Read,
    h: &TrrHeader,
    coords: bool,
    velocities: bool,
    forces: bool,
) -> Result<State, TrrHandlerError> {
    let elem = if h.b_double { 8usize } else { 4usize };
    let n = h.natoms as usize;

    // Box
    let pbox = if h.box_size != 0 {
        let vals: Vec<f32> = if h.b_double {
            (0..9).map(|_| xdr_read_f64(r).map(|v| v as f32)).collect::<io::Result<_>>()?
        } else {
            (0..9).map(|_| xdr_read_f32(r)).collect::<io::Result<_>>()?
        };
        let m = Matrix3f::from_iterator(vals.into_iter());
        Some(PeriodicBox::from_matrix(m)?)
    } else {
        None
    };

    // vir (skip)
    if h.vir_size != 0 {
        xdr_skip(r, 9 * elem)?;
    }

    // pres (skip)
    if h.pres_size != 0 {
        xdr_skip(r, 9 * elem)?;
    }

    // Coordinates
    let coord_data: Vec<Pos> = if h.x_size != 0 {
        if coords {
            if h.b_double {
                (0..n).map(|_| {
                    let x = xdr_read_f64(r)? as f32;
                    let y = xdr_read_f64(r)? as f32;
                    let z = xdr_read_f64(r)? as f32;
                    Ok(Pos::new(x, y, z))
                }).collect::<io::Result<_>>()?
            } else {
                (0..n).map(|_| {
                    let x = xdr_read_f32(r)?;
                    let y = xdr_read_f32(r)?;
                    let z = xdr_read_f32(r)?;
                    Ok(Pos::new(x, y, z))
                }).collect::<io::Result<_>>()?
            }
        } else {
            xdr_skip(r, n * 3 * elem)?;
            Vec::new()
        }
    } else {
        Vec::new()
    };

    // Velocities
    let vel_data: Vec<Vel> = if h.v_size != 0 {
        if velocities {
            read_xvf(r, n, h.b_double)?
        } else {
            xdr_skip(r, n * 3 * elem)?;
            Vec::new()
        }
    } else {
        Vec::new()
    };

    // Forces
    let force_data: Vec<Force> = if h.f_size != 0 {
        if forces {
            read_xvf(r, n, h.b_double)?
        } else {
            xdr_skip(r, n * 3 * elem)?;
            Vec::new()
        }
    } else {
        Vec::new()
    };

    Ok(State {
        coords: coord_data,
        velocities: vel_data,
        forces: force_data,
        pbox,
        time: h.time,
    })
}

/// Skip a frame's data section (already read header).
fn skip_frame_data(r: &mut (impl Read + Seek), h: &TrrHeader) -> io::Result<()> {
    let size = frame_data_size(h) as i64;
    r.seek(SeekFrom::Current(size))?;
    Ok(())
}

//=============================== FileFormatHandler impl ===================

impl FileFormatHandler for TrrFileHandler {
    fn open(fname: impl AsRef<Path>) -> Result<Self, FileFormatError>
    where
        Self: Sized,
    {
        let fname = fname.as_ref();
        let file = File::open(fname).map_err(TrrHandlerError::Io)?;
        let mut reader = BufReader::new(file);

        // Read first header to get natoms, then rewind
        let h = read_trr_header(&mut reader).map_err(trr_to_ff_err)?;
        let natoms = h.natoms as usize;
        reader.seek(SeekFrom::Start(0)).map_err(TrrHandlerError::Io)?;

        let _ = natoms; // validated but not stored
        Ok(TrrFileHandler::Reader(TrrReader {
            file: reader,
            cur_frame: 0,
        }))
    }

    fn create(fname: impl AsRef<Path>) -> Result<Self, FileFormatError>
    where
        Self: Sized,
    {
        let fname = fname.as_ref();
        let file = File::create(fname).map_err(TrrHandlerError::Io)?;
        Ok(TrrFileHandler::Writer(TrrWriter {
            file: BufWriter::new(file),
            cur_frame: 0,
            natoms: None,
        }))
    }

    fn read_state(&mut self) -> Result<State, FileFormatError> {
        let TrrFileHandler::Reader(ref mut r) = self else {
            return Err(FileFormatError::NotStateReadFormat);
        };

        let h = read_trr_header(&mut r.file).map_err(trr_to_ff_err)?;
        let st = read_frame_data(&mut r.file, &h, true, true, true).map_err(trr_to_ff_err)?;
        r.cur_frame += 1;
        Ok(st)
    }

    fn read_state_pick(&mut self, coords: bool, velocities: bool, forces: bool) -> Result<State, FileFormatError> {
        if !coords {
            return Err(FileFormatError::NoCoords);
        }
        let TrrFileHandler::Reader(ref mut r) = self else {
            return Err(FileFormatError::NotStateReadFormat);
        };

        let h = read_trr_header(&mut r.file).map_err(trr_to_ff_err)?;
        let st = read_frame_data(&mut r.file, &h, coords, velocities, forces).map_err(trr_to_ff_err)?;
        r.cur_frame += 1;
        Ok(st)
    }

    fn write_state(&mut self, data: &dyn SaveState) -> Result<(), FileFormatError> {
        self.write_state_pick(data, true, true, true)
    }

    fn write_state_pick(&mut self, data: &dyn SaveState, coords: bool, velocities: bool, forces: bool) -> Result<(), FileFormatError> {
        let TrrFileHandler::Writer(ref mut w) = self else {
            return Err(FileFormatError::NotStateWriteFormat);
        };

        let natoms = data.len();
        if w.natoms.is_none() {
            w.natoms = Some(natoms);
        }

        let has_box = data.get_box().is_some();
        let box_size = if has_box { 9 * 4i32 } else { 0i32 };
        let x_size = if coords     { natoms as i32 * 3 * 4 } else { 0 };

        let vel_it   = if velocities { data.iter_vel_dyn()   } else { Box::new(std::iter::empty()) };
        let force_it = if forces     { data.iter_force_dyn() } else { Box::new(std::iter::empty()) };

        let v_size = if vel_it.len() > 0   { natoms as i32 * 3 * 4 } else { 0 };
        let f_size = if force_it.len() > 0 { natoms as i32 * 3 * 4 } else { 0 };

        let h = TrrHeader {
            box_size,
            vir_size: 0,
            pres_size: 0,
            x_size,
            v_size,
            f_size,
            natoms: natoms as i32,
            step: w.cur_frame as i32,
            time: data.get_time(),
            b_double: false,
        };

        write_trr_header(&mut w.file, &h)?;

        // Write box (row-major, 9 f32)
        if let Some(b) = data.get_box() {
            for &v in b.get_matrix().as_slice() {
                xdr_write_f32(&mut w.file, v)?;
            }
        }

        // Write coordinates
        if coords {
            for p in data.iter_pos_dyn() {
                xdr_write_f32(&mut w.file, p.x)?;
                xdr_write_f32(&mut w.file, p.y)?;
                xdr_write_f32(&mut w.file, p.z)?;
            }
        }

        // Write velocities
        for v in vel_it {
            xdr_write_f32(&mut w.file, v.x)?;
            xdr_write_f32(&mut w.file, v.y)?;
            xdr_write_f32(&mut w.file, v.z)?;
        }

        // Write forces
        for f in force_it {
            xdr_write_f32(&mut w.file, f.x)?;
            xdr_write_f32(&mut w.file, f.y)?;
            xdr_write_f32(&mut w.file, f.z)?;
        }

        w.cur_frame += 1;
        Ok(())
    }

    fn seek_frame(&mut self, fr: usize) -> Result<(), FileFormatError> {
        let TrrFileHandler::Reader(ref mut r) = self else {
            return Err(FileFormatError::NotRandomAccessFormat);
        };

        if fr == r.cur_frame {
            return Ok(());
        }

        // If seeking backwards, rewind to start
        if fr < r.cur_frame {
            r.file
                .seek(SeekFrom::Start(0))
                .map_err(|e| TrrHandlerError::SeekFrame(fr, e))?;
            r.cur_frame = 0;
        }

        // Skip forward fr - cur_frame frames
        let skip = fr - r.cur_frame;
        for _ in 0..skip {
            let h = read_trr_header(&mut r.file)
                .map_err(|e| match e {
                    TrrHandlerError::Io(io_e) => TrrHandlerError::Io(io_e),
                    other => TrrHandlerError::Io(io::Error::new(io::ErrorKind::Other, other.to_string())),
                })?;
            skip_frame_data(&mut r.file, &h)
                .map_err(|e| TrrHandlerError::SeekFrame(fr, e))?;
            r.cur_frame += 1;
        }

        Ok(())
    }

    fn seek_last(&mut self) -> Result<(), FileFormatError> {
        let TrrFileHandler::Reader(ref mut r) = self else {
            return Err(FileFormatError::NotRandomAccessFormat);
        };

        // Rewind and scan all frames, track last valid frame start position
        r.file
            .seek(SeekFrom::Start(0))
            .map_err(TrrHandlerError::Io)?;
        r.cur_frame = 0;

        let mut last_pos: Option<u64> = None;
        let mut last_frame: usize = 0;
        let mut frame_idx: usize = 0;

        loop {
            let pos = r.file.stream_position().map_err(TrrHandlerError::Io)?;
            match read_trr_header(&mut r.file) {
                Ok(h) => {
                    last_pos = Some(pos);
                    last_frame = frame_idx;
                    match skip_frame_data(&mut r.file, &h) {
                        Ok(()) => {}
                        Err(_) => break,
                    }
                    frame_idx += 1;
                }
                Err(TrrHandlerError::Io(e)) if e.kind() == io::ErrorKind::UnexpectedEof => break,
                Err(e) => return Err(FileFormatError::from(e)),
            }
        }

        match last_pos {
            Some(pos) => {
                r.file
                    .seek(SeekFrom::Start(pos))
                    .map_err(TrrHandlerError::Io)?;
                r.cur_frame = last_frame;
                Ok(())
            }
            None => Err(FileFormatError::Eof),
        }
    }

    fn seek_time(&mut self, t: f32) -> Result<(), FileFormatError> {
        let TrrFileHandler::Reader(ref mut r) = self else {
            return Err(FileFormatError::NotRandomAccessFormat);
        };

        // Rewind then scan until frame.time >= t
        r.file
            .seek(SeekFrom::Start(0))
            .map_err(TrrHandlerError::Io)?;

        let mut frame_idx: usize = 0;

        loop {
            let pos = r.file.stream_position().map_err(TrrHandlerError::Io)?;
            match read_trr_header(&mut r.file) {
                Ok(h) => {
                    if h.time >= t {
                        // Seek back to this frame's start
                        r.file
                            .seek(SeekFrom::Start(pos))
                            .map_err(|e| TrrHandlerError::SeekTime(t, e))?;
                        r.cur_frame = frame_idx;
                        return Ok(());
                    }
                    skip_frame_data(&mut r.file, &h)
                        .map_err(|e| TrrHandlerError::SeekTime(t, e))?;
                    frame_idx += 1;
                }
                Err(TrrHandlerError::Io(e)) if e.kind() == io::ErrorKind::UnexpectedEof => {
                    return Err(FileFormatError::Eof);
                }
                Err(e) => return Err(FileFormatError::from(e)),
            }
        }
    }
}

/// Map TrrHandlerError to FileFormatError, converting UnexpectedEof to FileFormatError::Eof.
fn trr_to_ff_err(e: TrrHandlerError) -> FileFormatError {
    if let TrrHandlerError::Io(ref io_err) = e {
        if io_err.kind() == io::ErrorKind::UnexpectedEof {
            return FileFormatError::Eof;
        }
    }
    FileFormatError::from(e)
}