diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 0b696a8..95cbe30 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-13T07:38:42","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-13T21:43:03","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/API/index.html b/dev/API/index.html index b8536ac..70a5ee1 100644 --- a/dev/API/index.html +++ b/dev/API/index.html @@ -1,5 +1,5 @@ -API Reference · Backboner.jl
GitHub

Backboner API

Backboner.Backbone — Type
Backbone{T<:Real,M<:AbstractMatrix{T}} <: AbstractVector{AbstractVector{T}}

The Backbone type is designed to efficiently store and manipulate the three-dimensional coordinates of backbone points.

source
Backboner.ChainedBonds — Type
ChainedBonds{T<:Real,V<:AbstractVector{T}}

A lazy way to store a backbone as a series of bond lengths, bond angles, and torsion_angles.

Examples

julia> backbone = Backbone(randn(Float32, 3, 660));
+API Reference · Backboner.jl
GitHub
Backboner API
Backboner.Backbone — Type
Backbone{T<:Real,M<:AbstractMatrix{T}} <: AbstractVector{AbstractVector{T}}
The Backbone type is designed to efficiently store and manipulate the three-dimensional coordinates of backbone points.
source
Backboner.ChainedBonds — Type
ChainedBonds{T<:Real,V<:AbstractVector{T}}
A lazy way to store a backbone as a series of bond lengths, bond angles, and torsion_angles.
Examples
julia> backbone = Backbone(randn(Float32, 3, 660));
 
 julia> bonds = ChainedBonds(backbone)
-ChainedBonds{Float64, Vector{Float64}} with 659 bond lengths, 658 bond angles, and 657 torsion angles
source
Backboner.get_displacements — Method
get_displacements(backbone, start, step, stride)
Get the displacements between points in backbone, where start is the index of the first point, step is the offset of the other points along the backbone (e.g. 1 for bond vectors), and stride is the number of points to skip after each step.
source
Backboner.get_distances — Method
get_distances(backbone, start, step, stride)
Get the Euclidean distances between points in backbone, where start is the index of the first point, step is the offset of the other points along the backbone (e.g. 1 for bond lengths), and stride is the number of points to skip after each step.
source

+ChainedBonds{Float64, Vector{Float64}} with 659 bond lengths, 658 bond angles, and 657 torsion angles
source
Backboner.get_displacements — Method
get_displacements(backbone, start, step, stride)

Get the displacements between points in backbone, where start is the index of the first point, step is the offset of the other points along the backbone (e.g. 1 for bond vectors), and stride is the number of points to skip after each step.

source
Backboner.get_distances — Method
get_distances(backbone, start, step, stride)

Get the Euclidean distances between points in backbone, where start is the index of the first point, step is the offset of the other points along the backbone (e.g. 1 for bond lengths), and stride is the number of points to skip after each step.

source
diff --git a/dev/index.html b/dev/index.html index d7d713f..c8165fd 100644 --- a/dev/index.html +++ b/dev/index.html @@ -17,4 +17,4 @@ ChainedBonds{Float32, Vector{Float32}} with 8 bond lengths, 7 bond angles, and 6 torsion angles julia> is_knotted(backbone) -false
+false
diff --git a/dev/objects.inv b/dev/objects.inv index 3e50b18..b3af622 100644 --- a/dev/objects.inv +++ b/dev/objects.inv @@ -1,6 +1,6 @@ # Sphinx inventory version 2 # Project: Backboner.jl -# Version: 0.12.0 +# Version: 0.12.1 # The remainder of this file is compressed using zlib. x͓k0܏P(FJL^kL$yvbQWc"Ib&9A>-m v{W}VA2p64Wפ%oZsv4/x)Z%GՉA*Lm