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
use std::{cmp::Ordering, fmt::Display, str::FromStr};
use crate::{
modification::Modification,
system::{da, r, Mass, Ratio},
AminoAcid, LinearPeptide, SequenceElement,
};
/// A tolerance around a given mass for searching purposes
#[derive(Clone, Copy, PartialEq, Debug)]
pub enum MassTolerance {
/// A relative search tolerance in parts per million
Ppm(f64),
/// An absolute tolerance defined by a constant offset from the mass (bounds are mass - tolerance, mass + tolerance)
Absolute(Mass),
}
impl MassTolerance {
/// Find the bounds around a given mass for this tolerance
pub fn bounds(&self, mass: Mass) -> (Mass, Mass) {
match self {
Self::Ppm(ppm) => (
da(mass.value * (1.0 - ppm / 1e6)),
da(mass.value * (1.0 + ppm / 1e6)),
),
Self::Absolute(tolerance) => (mass - *tolerance, mass + *tolerance),
}
}
/// See if these two masses are within this tolerance of each other
pub fn within(&self, a: Mass, b: Mass) -> bool {
match self {
Self::Absolute(tol) => (a.value - b.value).abs() <= tol.value,
Self::Ppm(ppm) => a.ppm(b) <= *ppm,
}
}
}
impl Display for MassTolerance {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}",
match self {
Self::Absolute(mass) => format!("{} da", mass.value),
Self::Ppm(ppm) => format!("{ppm} ppm"),
}
)
}
}
impl FromStr for MassTolerance {
type Err = ();
fn from_str(s: &str) -> Result<Self, Self::Err> {
let num_str = String::from_utf8(
s.bytes()
.take_while(|c| {
c.is_ascii_digit()
|| *c == b'.'
|| *c == b'-'
|| *c == b'+'
|| *c == b'e'
|| *c == b'E'
})
.collect::<Vec<_>>(),
)
.map_err(|_| ())?;
let num = num_str.parse::<f64>().map_err(|_| ())?;
match s[num_str.len()..].trim() {
"ppm" => Ok(Self::Ppm(num)),
"da" => Ok(Self::Absolute(da(num))),
_ => Err(()),
}
}
}
impl TryFrom<&str> for MassTolerance {
type Error = ();
fn try_from(value: &str) -> Result<Self, ()> {
value.parse()
}
}
/// A list of building blocks for a sequence defined by its sequence elements and its mass.
pub type BuildingBlocks = Vec<(SequenceElement, Mass)>;
/// Get the possible building blocks for sequences based on the given modifications.
/// Useful for any automated sequence generation, like isobaric set generation or de novo sequencing.
/// The result is for each location (N term, center, C term) the list of all possible building blocks with its mass, sorted on mass.
pub fn building_blocks(
fixed: &[Modification],
variable: &[Modification],
) -> (BuildingBlocks, BuildingBlocks, BuildingBlocks) {
let generate = |index| {
let mut options: Vec<(SequenceElement, Mass)> = AA
.iter()
.flat_map(|aa| {
let mut options = Vec::new();
options.extend(
fixed
.iter()
.filter(|&m| can_be_placed(m, &SequenceElement::new(*aa, None), 0, 1))
.map(|m| SequenceElement {
aminoacid: *aa,
ambiguous: None,
modifications: vec![m.clone()],
possible_modifications: Vec::new(),
}),
);
if options.is_empty() {
vec![SequenceElement::new(*aa, None)]
} else {
options
}
})
.flat_map(|seq| {
let mut options = vec![seq.clone()];
options.extend(
variable
.iter()
.filter(|&m| can_be_placed(m, &seq, index, 2))
.map(|m| {
let mut modifications = seq.modifications.clone();
modifications.push(m.clone());
SequenceElement {
aminoacid: seq.aminoacid,
ambiguous: None,
modifications,
possible_modifications: Vec::new(),
}
}),
);
options
})
.map(|s| {
(
s.clone(),
s.formula_all().unwrap().monoisotopic_mass().unwrap(),
)
})
.collect();
options.sort_unstable_by(|a, b| a.1.partial_cmp(&b.1).unwrap());
options
};
// Create the building blocks
(generate(0), generate(1), generate(2))
}
/// Find the isobaric sets for the given mass with the given modifications and ppm error.
/// The modifications are placed on any location they are allowed based on the given placement
/// rules, so using any modifications which provide those is advised.
/// # Panics
/// Panics if any of the modifications does not have a defined mass.
pub fn find_isobaric_sets(
mass: Mass,
tolerance: MassTolerance,
fixed: &[Modification],
variable: &[Modification],
) -> IsobaricSetIterator {
let bounds = tolerance.bounds(mass);
let (n_term, center, c_term) = building_blocks(fixed, variable);
IsobaricSetIterator::new(n_term, c_term, center, bounds)
}
/// Iteratively generate isobaric sets based on the given settings.
#[derive(Debug)]
pub struct IsobaricSetIterator {
n_term: Vec<(SequenceElement, Mass)>,
c_term: Vec<(SequenceElement, Mass)>,
center: Vec<(SequenceElement, Mass)>,
sizes: (Mass, Mass),
bounds: (Mass, Mass),
state: (Option<usize>, Option<usize>, Vec<usize>),
}
impl IsobaricSetIterator {
fn new(
n_term: Vec<(SequenceElement, Mass)>,
c_term: Vec<(SequenceElement, Mass)>,
center: Vec<(SequenceElement, Mass)>,
bounds: (Mass, Mass),
) -> Self {
let sizes = (center.first().unwrap().1, center.last().unwrap().1);
let mut iter = Self {
n_term,
c_term,
center,
sizes,
bounds,
state: (None, None, Vec::new()),
};
while iter.current_mass() < iter.bounds.0 - iter.sizes.0 {
iter.state.2.push(0);
}
iter
}
fn current_mass(&self) -> Mass {
let mass = self.state.0.map(|i| self.n_term[i].1).unwrap_or_default()
+ self.state.1.map(|i| self.c_term[i].1).unwrap_or_default()
+ self
.state
.2
.iter()
.copied()
.map(|i| self.center[i].1)
.sum::<Mass>();
//println!("{}\t{}", mass.value, self.peptide());
mass
}
fn mass_fits(&self) -> Ordering {
let mass = self.current_mass();
if mass < self.bounds.0 {
Ordering::Less
} else if mass > self.bounds.1 {
Ordering::Greater
} else {
Ordering::Equal
}
}
fn peptide(&self) -> LinearPeptide {
let mut sequence = Vec::with_capacity(
self.state.2.len()
+ usize::from(self.state.0.is_some())
+ usize::from(self.state.1.is_some()),
);
if let Some(n) = self.state.0.map(|i| self.n_term[i].clone()) {
sequence.push(n.0);
}
sequence.extend(
self.state
.2
.iter()
.copied()
.map(|i| self.center[i].0.clone()),
);
if let Some(c) = self.state.1.map(|i| self.c_term[i].clone()) {
sequence.push(c.0);
}
LinearPeptide {
global: Vec::new(),
labile: Vec::new(),
n_term: None,
c_term: None,
sequence,
ambiguous_modifications: Vec::new(),
charge_carriers: None,
}
}
}
impl Iterator for IsobaricSetIterator {
type Item = LinearPeptide;
fn next(&mut self) -> Option<Self::Item> {
// TODO: no check is done for the N and C terminal options
while !self.state.2.is_empty() {
// Do state + 1 at the highest level where this is still possible and check if that one fits the bounds
// Until every level is full then pop and try with one fewer number of aminoacids
while !self.state.2.iter().all(|s| *s == self.center.len() - 1) {
let mut level = self.state.2.len() - 1;
loop {
if self.state.2[level] == self.center.len() - 1 {
if level == 0 {
break;
}
level -= 1;
} else {
// Update this level
self.state.2[level] += 1;
// Reset the levels above, has to start at minimal at the index of this level to prevent 'rotations' of the set to show up
for l in level + 1..self.state.2.len() {
self.state.2[l] = self.state.2[level];
}
match self.mass_fits() {
Ordering::Greater => {
// If the mass is too great the level below will have the be changed, otherwise it could only be getting heavier with the next iteration(s)
if level == 0 {
break;
}
level -= 1;
}
Ordering::Equal => {
return Some(self.peptide());
}
Ordering::Less => {
// If there a way to reach at least the lower limit by having all the heaviest options selected try and reach them.
// Otherwise this will increase this level again next iteration.
if self.state.2[0..level]
.iter()
.map(|i| self.center[*i].1)
.sum::<Mass>()
+ Ratio::new::<r>((self.state.2.len() - level) as f64)
* self.sizes.1
> self.bounds.0
{
level = self.state.2.len() - 1;
}
}
}
}
}
}
self.state.2.pop();
// Stop the search when there is no possibility for a fitting answer
if self.sizes.1 * Ratio::new::<r>(self.state.2.len() as f64) < self.bounds.0 {
return None;
}
// Reset the levels to be all 0s again
for level in 0..self.state.2.len() {
self.state.2[level] = 0;
}
}
None
}
}
/// Enforce the placement rules of predefined modifications.
fn can_be_placed(
modification: &Modification,
seq: &SequenceElement,
index: usize,
length: usize,
) -> bool {
if let Modification::Predefined(_, rules, _, _, _) = modification {
rules.is_empty()
|| rules
.iter()
.any(|rule| rule.is_possible(seq, index, length))
} else {
true
}
}
const AA: &[AminoAcid] = &[
AminoAcid::Glycine,
AminoAcid::Alanine,
AminoAcid::Arginine,
AminoAcid::Asparagine,
AminoAcid::AsparticAcid,
AminoAcid::Cysteine,
AminoAcid::Glutamine,
AminoAcid::GlutamicAcid,
AminoAcid::Histidine,
AminoAcid::AmbiguousLeucine,
AminoAcid::Lysine,
AminoAcid::Methionine,
AminoAcid::Phenylalanine,
AminoAcid::Proline,
AminoAcid::Serine,
AminoAcid::Threonine,
AminoAcid::Tryptophan,
AminoAcid::Tyrosine,
AminoAcid::Valine,
AminoAcid::Selenocysteine,
AminoAcid::Pyrrolysine,
];
#[cfg(test)]
mod tests {
use crate::ComplexPeptide;
use super::*;
#[test]
fn simple_isobaric_sets() {
let pep = ComplexPeptide::pro_forma("AG").unwrap().assume_linear();
let sets: Vec<LinearPeptide> = find_isobaric_sets(
pep.bare_formula().unwrap().monoisotopic_mass().unwrap(),
MassTolerance::Ppm(10.0),
&[],
&[],
)
.collect();
assert_eq!(
&sets,
&[
ComplexPeptide::pro_forma("GA").unwrap().assume_linear(),
ComplexPeptide::pro_forma("Q").unwrap().assume_linear(),
]
);
}
}