Struct codenano::Helix

pub struct Helix {
    pub origin: Point<f64>,
    pub roll: f64,
    pub yaw: f64,
    pub pitch: f64,
}

A DNA helix. All bases of all strands must be on a helix.

The three angles are illustrated in the following image, from the NASA website:

Fields

origin: Point<f64>

Position of the origin of the helix axis.

roll: f64

Angle around the axis of the helix.

yaw: f64

Horizontal rotation.

pitch: f64

Vertical rotation.

Implementations

impl Helix

pub fn theta(&self, n: isize, right: bool, cst: &Parameters) -> f64

Angle of base number n around this helix.

pub fn space_pos(&self, p: &Parameters, n: isize, right: bool) -> [f64; 3]

3D position of a nucleotide on this helix. n is the position along the axis, and right is true iff the 5' to 3' direction of the strand containing that nucleotide runs in the same direction as the axis of the helix.

pub fn basis(&self) -> [[f64; 3]; 3]

Return a basis of the Helix PoV

pub fn axis_pos(&self, p: &Parameters, n: isize) -> [f64; 3]

3D position of the projection of the nucleotide on its helix. n is the position along the axis.

pub fn overlap(&self, other: &Helix, p: &Parameters) -> bool

Test if two helices overlap.

pub fn clone_up(&self, p: &Parameters) -> Self

A clone of self translated by one step along the y vector

pub fn clone_down(&self, p: &Parameters) -> Self

A clone of self translated by minus one step along the y vector

pub fn clone_left(&self, p: &Parameters) -> Self

A clone of self translated by minus one step along the z vector

pub fn clone_right(&self, p: &Parameters) -> Self

A clone of self translated by one step along the z vector

pub fn closest_nucl<F: Into<f64> + Copy>(
    &self,
    point: [F; 3],
    p: &Parameters
) -> isize

Return the position on axis that is the closest to the point given in argument

Trait Implementations

impl Clone for Helix

fn clone(&self) -> Helix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Helix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Helix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Helix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.