tpt_sci_ode/
trajectory.rs1use std::fmt::Write as _;
8use std::io;
9
10use crate::error::OdeError;
11use crate::problem::OdeProblem;
12use crate::solver::Method;
13
14#[derive(Debug, Clone, PartialEq)]
19#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
20pub struct Trajectory {
21 pub t: Vec<f64>,
23 pub names: Vec<String>,
25 pub y: Vec<Vec<f64>>,
27}
28
29impl Trajectory {
30 pub fn new(t: Vec<f64>, names: Vec<String>, y: Vec<Vec<f64>>) -> Result<Self, OdeError> {
37 if t.len() != y.len() {
38 return Err(OdeError::invalid(format!(
39 "trajectory has {} times but {} states",
40 t.len(),
41 y.len()
42 )));
43 }
44 if let Some((k, row)) = y.iter().enumerate().find(|(_, r)| r.len() != names.len()) {
45 return Err(OdeError::invalid(format!(
46 "state row {k} has {} entries, expected {}",
47 row.len(),
48 names.len()
49 )));
50 }
51 Ok(Self { t, names, y })
52 }
53
54 #[must_use]
56 pub fn len(&self) -> usize {
57 self.t.len()
58 }
59
60 #[must_use]
62 pub fn is_empty(&self) -> bool {
63 self.t.is_empty()
64 }
65
66 #[must_use]
69 pub fn column(&self, name: &str) -> Option<Vec<f64>> {
70 let idx = self.names.iter().position(|n| n == name)?;
71 Some(self.y.iter().map(|row| row[idx]).collect())
72 }
73
74 #[must_use]
78 pub fn to_csv(&self) -> String {
79 let mut out = String::new();
80 out.push('t');
81 for name in &self.names {
82 out.push(',');
83 out.push_str(&escape_csv_field(name));
84 }
85 out.push('\n');
86 for (t, row) in self.t.iter().zip(&self.y) {
87 let _ = write!(out, "{t}");
89 for v in row {
90 let _ = write!(out, ",{v}");
91 }
92 out.push('\n');
93 }
94 out
95 }
96
97 pub fn write_csv<W: io::Write>(&self, mut writer: W) -> io::Result<()> {
103 writer.write_all(self.to_csv().as_bytes())
104 }
105}
106
107impl OdeProblem {
108 pub fn solve_trajectory(
118 &self,
119 method: Method,
120 t_eval: &[f64],
121 names: &[&str],
122 ) -> Result<Trajectory, OdeError> {
123 if names.len() != self.nstates() {
124 return Err(OdeError::invalid(format!(
125 "{} names given for {} state variables",
126 names.len(),
127 self.nstates()
128 )));
129 }
130 let y = self.solve_dense(method, t_eval)?;
131 let names = names.iter().map(|n| (*n).to_string()).collect();
132 Trajectory::new(t_eval.to_vec(), names, y)
133 }
134}
135
136fn escape_csv_field(field: &str) -> String {
138 if field.contains([',', '"', '\n', '\r']) {
139 format!("\"{}\"", field.replace('"', "\"\""))
140 } else {
141 field.to_string()
142 }
143}
144
145#[cfg(test)]
146mod tests {
147 use super::*;
148
149 fn sample() -> Trajectory {
150 Trajectory::new(
151 vec![0.0, 0.5],
152 vec!["x".into(), "a,b".into()],
153 vec![vec![1.0, 2.0], vec![3.0, 4.5]],
154 )
155 .unwrap()
156 }
157
158 #[test]
159 fn csv_has_header_and_one_row_per_time() {
160 let csv = sample().to_csv();
161 assert_eq!(csv, "t,x,\"a,b\"\n0,1,2\n0.5,3,4.5\n");
162 }
163
164 #[test]
165 fn column_lookup_by_name() {
166 let tr = sample();
167 assert_eq!(tr.column("x"), Some(vec![1.0, 3.0]));
168 assert_eq!(tr.column("missing"), None);
169 }
170
171 #[test]
172 fn rejects_mismatched_shapes() {
173 let bad_len = Trajectory::new(vec![0.0], vec!["x".into()], vec![]);
174 assert!(bad_len.is_err());
175 let bad_row = Trajectory::new(vec![0.0], vec!["x".into()], vec![vec![1.0, 2.0]]);
176 assert!(bad_row.is_err());
177 }
178
179 #[test]
180 fn write_csv_matches_to_csv() {
181 let tr = sample();
182 let mut buf = Vec::new();
183 tr.write_csv(&mut buf).unwrap();
184 assert_eq!(String::from_utf8(buf).unwrap(), tr.to_csv());
185 }
186}