Struct Position 

pub struct Position<S: System> { /* private fields */ }

An offset from the start of a molecule.

For a more in-depth discussion on what positions are and the notations used within this crate, please see this section of the docs.

Implementations

impl Position<Base>

pub const fn try_new(value: Number) -> Result<Self>

Create a new base position if the value is not zero.

Examples

use omics_coordinate::position::base::Position;

let position = Position::try_new(1)?;
assert_eq!(position.get(), 1);

impl Position<Interbase>

pub const fn new(value: Number) -> Self

Creates a new interbase position.

Examples

use omics_coordinate::position::interbase::Position;

let position = Position::new(0);
assert_eq!(position.get(), 0);

impl<S: System> Position<S>

pub fn get(&self) -> Number

Gets the numerical position.

Examples

use omics_coordinate::Position;
use omics_coordinate::system::Interbase;

let position = Position::<Interbase>::new(42);
assert_eq!(position.get(), 42);

pub fn checked_add(&self, rhs: Number) -> Option<Self>

where Self: Position<S>,

Performs checked addition.

Examples

use omics_coordinate::Position;
use omics_coordinate::system::Interbase;

let position = Position::<Interbase>::new(42)
    .checked_add(8)
    .expect("addition to succeed");
assert_eq!(position.get(), 50);

pub fn checked_sub(&self, rhs: Number) -> Option<Self>

where Self: Position<S>,

Performs checked subtraction.

Examples

use omics_coordinate::Position;
use omics_coordinate::system::Interbase;

let position = Position::<Interbase>::new(42)
    .checked_sub(2)
    .expect("subtraction to succeed");
assert_eq!(position.get(), 40);

Trait Implementations

impl<S: Clone + System> Clone for Position<S>

fn clone(&self) -> Position<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + System> Debug for Position<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: System> Display for Position<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Ord + System> Ord for Position<S>

fn cmp(&self, other: &Position<S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<S: PartialEq + System> PartialEq for Position<S>

fn eq(&self, other: &Position<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: PartialOrd + System> PartialOrd for Position<S>

fn partial_cmp(&self, other: &Position<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: Copy + System> Copy for Position<S>

impl<S: Eq + System> Eq for Position<S>

impl<S: System> StructuralPartialEq for Position<S>