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 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
#![allow(dead_code)]
use crate::reference_tables;
use crate::structs::*;
use crate::transformation::TransformationMatrix;
use std::cmp::Ordering;
use std::convert::TryInto;
use std::fmt;
use std::sync::atomic::{AtomicUsize, Ordering as AtomicOrdering};
static ATOM_COUNTER: AtomicUsize = AtomicUsize::new(0);
/// A struct to represent a single Atom in a protein.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug)]
pub struct Atom {
/// The unique serial number given to this atom
counter: usize,
/// Determines if this atom is a hetero atom (true), a non standard atom, or a normal atom (false)
hetero: bool,
/// The serial number of the Atom, should be unique within its model
serial_number: usize,
/// The name of the Atom, can only use the standard allowed characters
name: String,
/// The X position of the Atom (Å)
x: f64,
/// The Y position of the Atom (Å)
y: f64,
/// The Z position of the Atom (Å)
z: f64,
/// The occupancy of the Atom
occupancy: f64,
/// The B-factor (or temperature factor) of the Atom
b_factor: f64,
/// The element of the Atom, can only use the standard allowed characters
element: Option<Element>,
/// The charge of the Atom
charge: isize,
/// The anisotropic temperature factors, if applicable
atf: Option<[[f64; 3]; 3]>,
}
impl Atom {
/// Create a new Atom. If no or an invalid element is given it tries to find the element
/// by using the full atom name as element. If this is not valid it will use the first
/// character of the name if it is one of "CHNOS".
#[allow(clippy::too_many_arguments)]
pub fn new(
hetero: bool,
serial_number: usize,
atom_name: impl Into<String>,
x: f64,
y: f64,
z: f64,
occupancy: f64,
b_factor: f64,
element: impl Into<String>,
charge: isize,
) -> Option<Atom> {
let atom_name = atom_name.into().trim().to_string();
let element = element.into().trim().to_string();
if valid_identifier(&atom_name)
&& valid_identifier(&element)
&& x.is_finite()
&& y.is_finite()
&& z.is_finite()
&& occupancy.is_finite()
&& b_factor.is_finite()
{
let element = if let Ok(elem) = element.as_str().try_into() {
Some(elem)
} else if let Ok(elem) = atom_name.as_str().try_into() {
Some(elem)
} else if !atom_name.is_empty() {
let char = atom_name.trim().chars().next();
if !atom_name.trim().is_empty() && "CHNOS".contains(char?) {
Element::from_symbol(char?.to_string().as_str())
} else {
None
}
} else {
None
};
Some(Atom {
counter: ATOM_COUNTER.fetch_add(1, AtomicOrdering::SeqCst),
hetero,
serial_number,
name: atom_name.trim().to_ascii_uppercase(),
x,
y,
z,
occupancy,
b_factor,
element,
charge,
atf: None,
})
} else {
None
}
}
/// Get a unique immutable counter for this atom.
pub(crate) const fn counter(&self) -> usize {
self.counter
}
/// Determine if this atom is an hetero atom (`true`), a non standard atom, or a normal atom (`false`).
pub const fn hetero(&self) -> bool {
self.hetero
}
/// Set whether this atom is an hetero atom (`true`), a non standard atom, or a normal atom (`false`).
pub fn set_hetero(&mut self, new_hetero: bool) {
self.hetero = new_hetero
}
/// Get the position of the atom as a tuple of `f64`, in the following order: (x, y, z).
/// Given in Å as defined by PDB in the orthogonal coordinate system.
pub const fn pos(&self) -> (f64, f64, f64) {
(self.x, self.y, self.z)
}
/// Set the position of the atom as a tuple of `f64`, in the following order: (x, y, z).
/// # Errors
/// It fails if one or more of the numbers is not finite (`f64.is_finite()`).
pub fn set_pos(&mut self, new_pos: (f64, f64, f64)) -> Result<(), String> {
if new_pos.0.is_finite() && new_pos.1.is_finite() && new_pos.2.is_finite() {
self.x = new_pos.0;
self.y = new_pos.1;
self.z = new_pos.2;
Ok(())
} else {
Err(format!(
"One (or more) of values of the new position is not finite for atom {} values {:?}",
self.serial_number, new_pos
))
}
}
/// Get the X position of the atom.
/// Given in Å as defined by PDB in the orthogonal coordinate system.
/// This number has a precision of 8.3 in PDB files and 5 decimal places of precision in mmCIF files.
pub const fn x(&self) -> f64 {
self.x
}
/// Set the X position of the atom in Å.
/// # Errors
/// It fails if `new_pos` is not finite (`f64.is_finite()`).
pub fn set_x(&mut self, new_pos: f64) -> Result<(), String> {
if new_pos.is_finite() {
self.x = new_pos;
Ok(())
} else {
Err(format!(
"The value of the new x position is not finite for atom {} value {}",
self.serial_number, new_pos
))
}
}
/// Get the Y position of the atom.
/// Given in Å as defined by PDB in the orthogonal coordinate system.
/// This number has a precision of 8.3 in PDB files and 5 decimal places of precision in mmCIF files.
pub const fn y(&self) -> f64 {
self.y
}
/// Set the Y position of the atom in Å.
/// # Errors
/// It fails if `new_pos` is not finite (`f64.is_finite()`).
pub fn set_y(&mut self, new_pos: f64) -> Result<(), String> {
if new_pos.is_finite() {
self.y = new_pos;
Ok(())
} else {
Err(format!(
"The value of the new y position is not finite for atom {} value {}",
self.serial_number, new_pos
))
}
}
/// Get the Z position of the atom.
/// Given in Å as defined by PDB in the orthogonal coordinate system.
/// This number has a precision of 8.3 in PDB files and 5 decimal places of precision in mmCIF files.
pub const fn z(&self) -> f64 {
self.z
}
/// Set the Z position of the atom in Å.
/// # Errors
/// It fails if `new_pos` is not finite (`f64.is_finite()`).
pub fn set_z(&mut self, new_pos: f64) -> Result<(), String> {
if new_pos.is_finite() {
self.z = new_pos;
Ok(())
} else {
Err(format!(
"The value of the new z position is not finite for atom {} value {}",
self.serial_number, new_pos
))
}
}
/// Get the serial number of the atom.
/// This number, combined with the `alt_loc` from the Conformer of this Atom, is defined to be unique in the containing model, which is not enforced.
/// The precision of this number is 5 digits in PDB files.
/// If more than 99,999 atoms are present in the same model, the internal numbering will
/// continue counting up even if the file from which the atoms were read does not.
/// Importantly, this will not affect the saving of the file, only the internal handling of
/// atom serial numbers.
pub const fn serial_number(&self) -> usize {
self.serial_number
}
/// Set the serial number of the atom.
/// This number, combined with the `alt_loc` from the Conformer, of this Atom is defined to be unique in the containing model, which is not enforced.
pub fn set_serial_number(&mut self, new_serial_number: usize) {
self.serial_number = new_serial_number;
}
/// Get the name of the atom. The name will be trimmed (whitespace removed) and changed to ASCII uppercase.
pub fn name(&self) -> &str {
&self.name
}
/// Set the name of the atom. The name will be trimmed (whitespace removed) and changed to ASCII uppercase as requested by PDB/PDBx standard.
/// For PDB files the name can at most contain 4 characters, enforced when saving the file.
/// # Errors
/// The name can only contain valid characters, the ASCII graphic characters (`char.is_ascii_graphic() || char == ' '`).
/// If the name is invalid an error message is provided.
pub fn set_name(&mut self, new_name: impl Into<String>) -> Result<(), String> {
let new_name = new_name.into();
if valid_identifier(&new_name) {
self.name = new_name.trim().to_ascii_uppercase();
Ok(())
} else {
Err(format!(
"New name has invalid characters for atom {} name {}",
self.serial_number, new_name
))
}
}
/// Get the occupancy or Q factor of the atom. This indicates the fraction of unit cells in which this atom is present, in the normal case this will be one (1) and it can range between 1 and 0 (inclusive).
/// This number has a precision of 6.2 in PDB files and 5 decimal places of precision in mmCIF files.
pub const fn occupancy(&self) -> f64 {
self.occupancy
}
/// Set the occupancy or Q factor of the atom.
/// # Errors
/// It fails if `new_occupancy` is not finite (`f64.is_finite()`) or if it is negative.
pub fn set_occupancy(&mut self, new_occupancy: f64) -> Result<(), String> {
if new_occupancy.is_finite() {
if new_occupancy >= 0.0 {
self.occupancy = new_occupancy;
Ok(())
} else {
Err(format!(
"The value of the new occupancy is negative for atom {} value {}",
self.serial_number, new_occupancy
))
}
} else {
Err(format!(
"The value of the new occupancy is not finite for atom {} value {}",
self.serial_number, new_occupancy
))
}
}
/// Get the B factor or temperature factor of the atom.
/// This indicates the uncertainty in the position of the atom as seen over all unit cells in the whole crystal.
/// A low uncertainty is modelled with a low B factor, with zero uncertainty being equal to a B factor of 0. A higher uncertainty is modelled by a high B factor.
/// This number has a precision of 6.2 in PDB files and 5 decimal places of precision in mmCIF files.
pub const fn b_factor(&self) -> f64 {
self.b_factor
}
/// Set the B factor or temperature factor of the atom.
/// # Errors
/// It fails if `new_b_factor` is not finite (`f64.is_finite()`) or if it is negative.
pub fn set_b_factor(&mut self, new_b_factor: f64) -> Result<(), String> {
if new_b_factor.is_finite() {
if new_b_factor >= 0.0 {
self.b_factor = new_b_factor;
Ok(())
} else {
Err(format!(
"The value of the new b_factor is negative for atom {} value {}",
self.serial_number, new_b_factor
))
}
} else {
Err(format!(
"The value of the new b_factor is not finite for atom {} value {}",
self.serial_number, new_b_factor
))
}
}
/// Get the element of this atom.
/// In PDB files the element can at most contain 2 characters.
pub fn element(&self) -> Option<&Element> {
self.element.as_ref()
}
/// Set the element of this atom.
pub fn set_element(&mut self, element: Element) {
self.element = Some(element);
}
/// Get the charge of the atom.
/// In PDB files the charge is one digit with a sign.
pub const fn charge(&self) -> isize {
self.charge
}
/// Set the charge of this atom.
/// In PDB files the charge is one digit with a sign.
pub fn set_charge(&mut self, new_charge: isize) {
self.charge = new_charge;
}
/// Get the charge in the PDB format `[0-9][-+]`. If the charge is 0 or outside bounds (below -9 or above 9) it returns an empty string.
#[allow(clippy::cast_possible_truncation)]
pub fn pdb_charge(&self) -> String {
if self.charge == 0 || self.charge < -9 || self.charge > 9 {
String::new()
} else {
let mut sign = '+';
let charge = (48 + self.charge.unsigned_abs() as u8) as char;
if self.charge < 0 {
sign = '-';
}
format!("{charge}{sign}")
}
}
/// Get the anisotropic temperature factors, if available.
/// This number has a precision of 8.3 in PDB files and 5 decimal places of precision in mmCIF files.
pub const fn anisotropic_temperature_factors(&self) -> Option<[[f64; 3]; 3]> {
self.atf
}
/// Set the anisotropic temperature factors.
pub fn set_anisotropic_temperature_factors(&mut self, factors: [[f64; 3]; 3]) {
self.atf = Some(factors);
}
/// Determine whether this atom is likely to be a part of the backbone of a protein.
/// This is based on this Atom only, for a more precise definition use [`hierarchy::ContainsAtomConformer::is_backbone`].
pub fn is_backbone(&self) -> bool {
reference_tables::is_backbone(self.name())
}
/// Apply a transformation using a given `TransformationMatrix` to the position of this atom, the new position is immediately set.
pub fn apply_transformation(&mut self, transformation: &TransformationMatrix) {
self.set_pos(transformation.apply(self.pos()))
.expect("Some numbers were invalid in applying a transformation");
}
/// See if the `other` Atom corresponds with this Atom.
/// This means that the Atoms are equal except for the position, occupancy, and b_factor.
/// Used to validate that multiple models contain the same atoms, but with different positional data.
pub fn corresponds(&self, other: &Atom) -> bool {
self.serial_number == other.serial_number
&& self.name() == other.name()
&& self.element() == other.element()
&& self.charge() == other.charge()
&& ((self.atf.is_none() && other.atf.is_none())
|| (self.atf.is_some() && other.atf.is_some()))
}
/// Gives the distance between the centers of two atoms in Aͦ.
pub fn distance(&self, other: &Atom) -> f64 {
(other.z - self.z)
.mul_add(
other.z - self.z,
(other.y - self.y).mul_add(other.y - self.y, (other.x - self.x).powi(2)),
)
.sqrt()
}
/// Gives the distance between the centers of two atoms in Aͦ, wrapping around the unit cell if needed.
/// This will give the shortest distance between the two atoms or any of their copies given a crystal of the size of the given unit cell stretching out to all sides.
pub fn distance_wrapping(&self, other: &Atom, cell: &UnitCell) -> f64 {
let mut x = other.x;
if (self.x - other.x).abs() > cell.a() / 2.0 {
if self.x > other.x {
x += cell.a();
} else {
x -= cell.a();
}
}
let mut y = other.y;
if (self.y - other.y).abs() > cell.b() / 2.0 {
if self.y > other.y {
y += cell.b();
} else {
y -= cell.b();
}
}
let mut z = other.z;
if (self.z - other.z).abs() > cell.c() / 2.0 {
if self.z > other.z {
z += cell.c();
} else {
z -= cell.c();
}
}
(z - self.z)
.mul_add(
z - self.z,
(y - self.y).mul_add(y - self.y, (x - self.x).powi(2)),
)
.sqrt()
}
#[allow(clippy::similar_names)]
/// Gives the angle between the centers of three atoms in degrees.
/// The angle is calculated as the angle between the two lines that include
/// atoms [1, 2] and [2, 3]
pub fn angle(&self, atom2: &Atom, atom3: &Atom) -> f64 {
let (a, b, c) = (self.pos(), atom2.pos(), atom3.pos());
// Form the two vectors
let ba = [a.0 - b.0, a.1 - b.1, a.2 - b.2];
let bc = [c.0 - b.0, c.1 - b.1, c.2 - b.2];
// Calculate absolute values of vectors
let abs_ba = ba.iter().fold(0.0, |acc, x| acc + (x * x)).sqrt();
let abs_bc = bc.iter().fold(0.0, |acc, x| acc + (x * x)).sqrt();
// Form dot product between vecs
let dot = ba
.iter()
.zip(bc.iter())
.fold(0.0, |acc, (a, b)| acc + (a * b));
// Calculate angle from all ingredients
(dot / (abs_ba * abs_bc)).acos().to_degrees()
}
#[allow(clippy::similar_names)]
/// Gives the dihedral between the centers of four atoms in degrees.
/// The angle is calculated as the angle between the two planes spanned by
/// atoms [1, 2, 3] and [2, 3, 4].
pub fn dihedral(&self, atom2: &Atom, atom3: &Atom, atom4: &Atom) -> f64 {
let (a, b, c, d) = (self.pos(), atom2.pos(), atom3.pos(), atom4.pos());
// Form vectors
let ba = [a.0 - b.0, a.1 - b.1, a.2 - b.2];
let bc = [c.0 - b.0, c.1 - b.1, c.2 - b.2];
let cb = [b.0 - c.0, b.1 - c.1, b.2 - c.2];
let cd = [d.0 - c.0, d.1 - c.1, d.2 - c.2];
// Form two normal vectors via cross products
let n1 = [
ba[1] * bc[2] - ba[2] * bc[1],
ba[2] * bc[0] - ba[0] * bc[2],
ba[0] * bc[1] - ba[1] * bc[0],
];
let n2 = [
cb[1] * cd[2] - cb[2] * cd[1],
cb[2] * cd[0] - cb[0] * cd[2],
cb[0] * cd[1] - cb[1] * cd[0],
];
// calculate abs of vecs
let abs_n1 = n1.iter().fold(0.0, |acc, x| acc + (x * x)).sqrt();
let abs_n2 = n2.iter().fold(0.0, |acc, x| acc + (x * x)).sqrt();
let dot = n1
.iter()
.zip(n2.iter())
.fold(0.0, |acc, (a, b)| acc + (a * b));
(dot / (abs_n1 * abs_n2)).acos().to_degrees()
}
/// Checks if this Atom overlaps with the given atom. It overlaps if the distance between the atoms is
/// less then the sum of the radius from this atom and the other atom. The used radius is [AtomicRadius].unbound.
///
/// Note: the atomic radius used is the unbound radius, this is in most cases bigger than the bound radius
/// and as such can result in false positives.
///
/// It fails if for any one of the two atoms the element or unbound radius is not known.
pub fn overlaps(&self, other: &Atom) -> Option<bool> {
self.element()
.map(Element::atomic_radius)
.and_then(|self_rad| {
other
.element()
.map(Element::atomic_radius)
.map(|other_rad| {
Some(self.distance(other) <= self_rad.unbound? + other_rad.unbound?)
})
})
.flatten()
}
/// Checks if this Atom overlaps with the given atom. It overlaps if the distance between the atoms is
/// less then the sum of the radius from this atom and the other atom. The used radius is [AtomicRadius].unbound.
/// Wrapping around the unit cell if needed. Meaning it will give the shortest distance between the two
/// atoms or any of their copies given a crystal of the size of the given unit cell stretching out to
/// all sides.
///
/// Note: the atomic radius used is the unbound radius, this is in most cases bigger than the bound radius
/// and as such can result in false positives.
///
/// It fails if for any one of the two atoms the element or unbound radius is not known.
pub fn overlaps_wrapping(&self, other: &Atom, cell: &UnitCell) -> Option<bool> {
self.element()
.map(Element::atomic_radius)
.and_then(|self_rad| {
other
.element()
.map(Element::atomic_radius)
.map(|other_rad| {
Some(
self.distance_wrapping(other, cell)
<= self_rad.unbound? + other_rad.unbound?,
)
})
})
.flatten()
}
/// Checks if this Atom overlaps with the given atom. It overlaps if the distance between the atoms is
/// less then the sum of the radius from this atom and the other atom. The used radius is [AtomicRadius].covalent_single.
///
/// Note: the atomic radius used in the bound radius to a single atom, this is similar to the bound radius for double or
/// triple bonds but could result in incorrect results.
///
/// It fails if for any one of the two atoms the element is not known.
pub fn overlaps_bound(&self, other: &Atom) -> Option<bool> {
self.element()
.map(Element::atomic_radius)
.and_then(|self_rad| {
other
.element()
.map(Element::atomic_radius)
.map(|other_rad| {
self.distance(other) <= self_rad.covalent_single + other_rad.covalent_single
})
})
}
/// Checks if this Atom overlaps with the given atom. It overlaps if the distance between the atoms is
/// less then the sum of the radius from this atom and the other atom. The used radius is [AtomicRadius].covalent_single.
/// Wrapping around the unit cell if needed. Meaning it will give the shortest distance between the two
/// atoms or any of their copies given a crystal of the size of the given unit cell stretching out to
/// all sides.
///
/// Note: the atomic radius used is the bound radius to a single atom, this is similar to the bound radius for double or
/// triple bonds but could result in incorrect results.
///
/// It fails if for any one of the two atoms the element is not known.
pub fn overlaps_bound_wrapping(&self, other: &Atom, cell: &UnitCell) -> Option<bool> {
self.element()
.map(Element::atomic_radius)
.and_then(|self_rad| {
other
.element()
.map(Element::atomic_radius)
.map(|other_rad| {
self.distance_wrapping(other, cell)
<= self_rad.covalent_single + other_rad.covalent_single
})
})
}
}
impl fmt::Display for Atom {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"ATOM ID: {}, Number: {}, Element: {}, X: {}, Y: {}, Z: {}, OCC: {}, B: {}, ANISOU: {}",
self.name(),
self.serial_number(),
self.element()
.map_or_else(|| "".to_string(), ToString::to_string),
self.x(),
self.y(),
self.z(),
self.occupancy(),
self.b_factor(),
self.atf.is_some()
)
}
}
impl Clone for Atom {
/// The clone implementation needs to use the constructor to guarantee the uniqueness of the counter
fn clone(&self) -> Self {
let mut atom = Atom::new(
self.hetero,
self.serial_number,
&self.name,
self.x,
self.y,
self.z,
self.occupancy,
self.b_factor,
self.element.map_or_else(|| "", |e| e.symbol()),
self.charge,
)
.expect("Invalid Atom properties in a clone");
atom.atf = self.atf;
atom
}
}
impl PartialEq for Atom {
fn eq(&self, other: &Self) -> bool {
self.serial_number == other.serial_number
&& self.name() == other.name()
&& self.element() == other.element()
&& self.charge() == other.charge()
&& self.atf == other.atf
&& self.pos() == other.pos()
&& self.occupancy == other.occupancy
&& self.b_factor == other.b_factor
}
}
/// As there are a lot of checks to make sure only 'normal' f64 values are used
/// Atom satisfies the properties needed for Eq while having f64 values.
impl Eq for Atom {}
impl PartialOrd for Atom {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.serial_number.cmp(&other.serial_number))
}
}
impl Ord for Atom {
fn cmp(&self, other: &Self) -> Ordering {
self.serial_number.cmp(&other.serial_number)
}
}
#[cfg(feature = "rstar")]
use rstar::{PointDistance, RTreeObject, AABB};
#[cfg(feature = "rstar")]
impl RTreeObject for &Atom {
type Envelope = AABB<(f64, f64, f64)>;
fn envelope(&self) -> Self::Envelope {
AABB::from_point(self.pos())
}
}
#[cfg(feature = "rstar")]
impl PointDistance for &Atom {
fn distance_2(&self, other: &(f64, f64, f64)) -> f64 {
// No square root as that is required by the package
(other.2 - self.z).mul_add(
other.2 - self.z,
(other.1 - self.y).mul_add(other.1 - self.y, (other.0 - self.x).powi(2)),
)
}
}
#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
use super::Atom;
use super::UnitCell;
#[test]
fn set_name() {
let mut a = Atom::new(false, 0, "", 0.0, 0.0, 0.0, 0.0, 0.0, "", 0).unwrap();
assert!(a.set_name("Å").is_err());
assert!(a.set_name("ATOMS").is_ok());
a.set_name("ATOM").unwrap();
a.set_name("HOH").unwrap();
a.set_name("RK").unwrap();
a.set_name("R").unwrap();
a.set_name("").unwrap();
}
#[test]
fn distance() {
let a = Atom::new(false, 0, "", 1.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
let b = Atom::new(false, 0, "", 9.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
let cell = UnitCell::new(10.0, 10.0, 10.0, 90.0, 90.0, 90.0);
assert!(!a.overlaps(&b).unwrap());
assert!(a.overlaps_wrapping(&b, &cell).unwrap());
assert_eq!(a.distance(&b), 8.0);
assert_eq!(a.distance_wrapping(&b, &cell), 2.0);
}
#[test]
fn angles() {
let a = Atom::new(false, 0, "", 1.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
let b = Atom::new(false, 0, "", 0.0, 1.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
let c = Atom::new(false, 0, "", 0.0, 0.0, 1.0, 0.0, 0.0, "C", 0).unwrap();
let d = Atom::new(false, 0, "", 1.0, 1.0, 1.0, 0.0, 0.0, "C", 0).unwrap();
let e = Atom::new(false, 0, "", 0.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
assert!((a.angle(&b, &c) - 60.0).abs() < 0.0001);
assert!((a.dihedral(&e, &c, &d) - 45.0).abs() < 0.0001);
}
#[test]
fn distance_all_axes() {
let a = Atom::new(false, 0, "", 1.0, 1.0, 1.0, 0.0, 0.0, "C", 0).unwrap();
let b = Atom::new(false, 0, "", 9.0, 9.0, 9.0, 0.0, 0.0, "C", 0).unwrap();
let cell = UnitCell::new(10.0, 10.0, 10.0, 90.0, 90.0, 90.0);
assert!(!a.overlaps(&b).unwrap());
assert!(a.overlaps_wrapping(&b, &cell).unwrap());
}
#[test]
fn check_equality() {
let a = Atom::new(false, 0, "", 1.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
let b = Atom::new(false, 1, "", 9.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
let c = Atom::new(false, 1, "", 9.0, 0.0, 0.0, 0.0, 0.0, "C", 0).unwrap();
assert_ne!(a, b);
assert_eq!(b, c);
assert_ne!(a, c);
}
#[test]
fn invalid_new_values() {
let mut a = Atom::new(false, 0, "", 1.0, 1.0, 1.0, 0.0, 0.0, "C", 0).unwrap();
assert!(Atom::new(false, 0, "Rͦ", 1.0, 1.0, 1.0, 0.0, 0.0, "C", 0).is_none());
assert!(Atom::new(false, 0, "R", 1.0, 1.0, 1.0, 0.0, 0.0, "Cͦ", 0).is_none());
assert!(a.set_x(f64::INFINITY).is_err());
assert!(a.set_x(f64::NAN).is_err());
assert!(a.set_x(f64::NEG_INFINITY).is_err());
assert!(a.set_y(f64::INFINITY).is_err());
assert!(a.set_z(f64::INFINITY).is_err());
assert!(a.set_pos((f64::INFINITY, 0., 0.)).is_err());
assert!(a.set_pos((0., f64::INFINITY, 0.)).is_err());
assert!(a.set_pos((0., 0., f64::INFINITY)).is_err());
assert!(a.set_b_factor(f64::INFINITY).is_err());
assert!(a.set_b_factor(-1.0).is_err());
assert!(a.set_occupancy(f64::INFINITY).is_err());
assert!(a.set_occupancy(-1.).is_err());
}
#[test]
fn check_setters() {
let mut a = Atom::new(false, 0, "C", 1.0, 1.0, 1.0, 0.0, 0.0, "", 0).unwrap();
assert!(a.set_x(2.0).is_ok());
assert_eq!(a.x(), 2.0);
assert!(a.set_y(2.0).is_ok());
assert_eq!(a.y(), 2.0);
assert!(a.set_z(2.0).is_ok());
assert_eq!(a.z(), 2.0);
assert!(a.set_pos((3.0, 3.0, 3.0)).is_ok());
assert_eq!(a.x(), 3.0);
assert_eq!(a.y(), 3.0);
assert_eq!(a.z(), 3.0);
assert_eq!(a.pos(), (3.0, 3.0, 3.0));
assert!(a.set_b_factor(2.0).is_ok());
assert_eq!(a.b_factor(), 2.0);
assert!(a.set_occupancy(2.0).is_ok());
assert_eq!(a.occupancy(), 2.0);
assert!(a.set_occupancy(0.0).is_ok());
assert!(a.set_b_factor(0.0).is_ok());
a.set_hetero(true);
assert!(a.hetero());
a.set_serial_number(42);
assert_eq!(a.serial_number(), 42);
assert_eq!(a.element().unwrap().atomic_number(), 6);
a.set_charge(-1);
assert_eq!(a.charge(), -1);
assert_eq!(a.pdb_charge(), "1-".to_string());
}
#[test]
fn check_radii() {
use crate::Element;
// No element defined because that should be taken from the atom name (out of PDB spec but common in PDB files)
let a = Atom::new(false, 0, "H", 1.0, 1.0, 1.0, 0.0, 0.0, "", 0).unwrap();
let radii = a.element().unwrap().atomic_radius();
assert_eq!(radii.unbound, Some(1.54));
assert_eq!(radii.van_der_waals, Some(1.20));
assert_eq!(radii.covalent_single, 0.32);
assert_eq!(radii.covalent_double, None);
assert_eq!(radii.covalent_triple, None);
assert_eq!(a.element().unwrap(), &Element::H);
let a = Atom::new(false, 0, "Cl", 1.0, 1.0, 1.0, 0.0, 0.0, "", 0).unwrap();
let radii = a.element().unwrap().atomic_radius();
assert_eq!(radii.unbound, Some(2.06));
assert_eq!(radii.van_der_waals, Some(1.82));
assert_eq!(radii.covalent_single, 0.99);
assert_eq!(radii.covalent_double, Some(0.95));
assert_eq!(radii.covalent_triple, Some(0.93));
assert_eq!(a.element().unwrap(), &Element::Cl);
let a = Atom::new(false, 0, "H3", 1.0, 1.0, 1.0, 0.0, 0.0, "", 0).unwrap();
let radii = a.element().unwrap().atomic_radius();
assert_eq!(radii.unbound, Some(1.54));
assert_eq!(radii.van_der_waals, Some(1.20));
assert_eq!(radii.covalent_single, 0.32);
assert_eq!(radii.covalent_double, None);
assert_eq!(radii.covalent_triple, None);
assert_eq!(a.element().unwrap(), &Element::H);
}
#[test]
fn check_display() {
let a = Atom::new(false, 0, "C", 1.0, 1.0, 1.0, 0.0, 0.0, "", 0).unwrap();
format!("{a:?}");
format!("{a}");
}
}