module Chem::ResidueCollection
Direct including types
Defined in:
chem/core/residue_collection.crInstance Method Summary
- #each_residue : Iterator(Residue)
- #each_residue(&block : Residue -> )
-
#each_residue_fragment(& : ResidueView -> ) : Nil
Iterates over residue-wise fragments.
-
#each_secondary_structure(reuse : Bool | Array(Residue) = false, strict : Bool = true, handedness : Bool = true) : Iterator(ResidueView)
Returns an iterator over secondary structure elements (SSEs).
-
#each_secondary_structure(reuse : Bool | Array(Residue) = false, strict : Bool = true, handedness : Bool = true, & : ResidueView, Protein::SecondaryStructure -> ) : Nil
Iterates over secondary structure elements (SSEs), yielding both the residues and secondary structure.
- #link_bond : Templates::Bond | Nil
- #n_residues : Int32
-
#reset_secondary_structure : self
Sets secondary structure of every residue to none.
-
#residue_fragments : Array(ResidueView)
Returns residue-wise fragments.
- #residues : ResidueView
- #sec=(seclist : Array(Protein::SecondaryStructure)) : Array(Protein::SecondaryStructure)
- #sec=(sec : Protein::SecondaryStructure) : Protein::SecondaryStructure
- #secondary_structures(strict : Bool = true, handedness : Bool = true) : Array(ResidueView)
Instance Method Detail
Iterates over residue-wise fragments.
A fragment is an array of inter-connected residues. Fragments are
dinamically computed by iterating over Residue#bonded_residues
of the selected residues.
NOTE fragments are scoped to the current list of residues such that bonded residues not contained in the list are omitted, e.g., given the list of residues [1, 2, 3, 4, 7, 8] belonging to the sequence 1-2-3-4-5-6 7-8-9, this method will return [[1, 2, 3, 4], [7, 8]], not [[1, 2, 3, 4, 5, 6], [7, 8, 9]].
Returns an iterator over secondary structure elements (SSEs).
SSEs are defined as segments of consecutive, bonded residues that
have the same secondary structure. If strict
is false
,
residues are grouped by their secondary structure type. If
handedness
is false
, handedness is not taken into account when
strict
is false
. See Protein::SecondaryStructure#equals?
.
Let's say a structure
has 25 residues with two beta strands
spanning residues 3-12 and 18-23, then:
iter = structure.each_secondary_structure
iter.next.map &.number # => [1, 2]
iter.next.map &.number # => [3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
iter.next.map &.number # => [13, 14, 15, 16, 17]
iter.next.map &.number # => [18, 19, 20, 21, 22, 23]
iter.next.map &.number # => [24, 25]
iter.next # => Iterator::Stop::INSTANCE
Note that non-protein residues are skipped over.
By default, a new array is created and yielded for each slice when
invoking next
.
- If reuse is
false
, a new array is created for each chunk. - If reuse is
true
, an array is created once and reused. - If reuse is an
Array
, it will be reused instead.
The latter can be used to prevent many memory allocations when each slice of interest is to be used in a read-only fashion.
Iterates over secondary structure elements (SSEs), yielding both the residues and secondary structure.
SSEs are defined as segments of consecutive, bonded residues that
have the same secondary structure. If strict
is false
,
residues are grouped by their secondary structure type. If
handedness
is false
, handedness is not taken into account when
strict
is false
. See Protein::SecondaryStructure#equals?
.
Let's say a structure
has 25 residues with two beta strands
spanning residues 3-12 and 18-23, then:
structure.each_secondary_structure do |sec, ary|
puts "#{sec.to_s} at #{ary[0].number}..#{ary[-1].number}"
end
Prints:
None at 1..2
BetaStrand at 3..12
None at 13..17
BetaStrand at 18..23
None at 24..25
Note that non-protein residues are skipped over.
By default, a new array is created and yielded for each slice when
invoking next
.
- If reuse is
false
, a new array is created for each chunk. - If reuse is
true
, an array is created once and reused. - If reuse is an
Array
, it will be reused instead.
The latter can be used to prevent many memory allocations when each slice of interest is to be used in a read-only fashion.
Returns residue-wise fragments. See #each_residue_fragment.