Skip to content

Commit

Permalink
Just a bit of docs before I got confused again
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Oct 7, 2023
1 parent 792c276 commit d77c997
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
11 changes: 7 additions & 4 deletions src/FiberBundle.jl
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
"""
FiberBundle{𝔽,TVS<:FiberType,TM<:AbstractManifold{𝔽},TVT<:FiberBundleProductVectorTransport} <: AbstractManifold{𝔽}
Fiber bundle on a [`AbstractManifold`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/types.html#ManifoldsBase.AbstractManifold) `M`
of type [`FiberType`](@ref).
Fiber bundle on a [`AbstractManifold`](@ref) `M` of type [`FiberType`](@ref).
Examples include vector bundles, principal bundles or unit tangent bundles, see also [πŸ“– Fiber Bundle](https://en.wikipedia.org/wiki/Fiber_bundle).
# Fields
* `manifold` – the [`AbstractManifold`](@ref) manifold the Fiber bundle is defined on
* `type` – representing the type of fiber we use.
# Constructor
FiberBundle(M::AbstractManifold, type::FiberType)
Expand All @@ -21,8 +24,6 @@ struct FiberBundle{
vector_transport::TVT
end

vector_bundle_transport(::FiberType, M::AbstractManifold) = ParallelTransport()

function FiberBundle(
fiber::TVS,
M::TM,
Expand All @@ -36,6 +37,8 @@ function FiberBundle(fiber::FiberType, M::AbstractManifold)
return FiberBundle(fiber, M, vtbm)
end

vector_bundle_transport(::FiberType, M::AbstractManifold) = ParallelTransport()

struct FiberBundleBasisData{BBasis<:CachedBasis,TBasis<:CachedBasis}
base_basis::BBasis
fiber_basis::TBasis
Expand Down
4 changes: 2 additions & 2 deletions src/VectorBundle.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

"""
VectorBundle{𝔽,TVS,TM,TVT}
VectorBundle{𝔽,TVS,TM,VTV} = = FiberBundle{𝔽, VectorSpaceFiberType{TVS},TM,TVT}
Alias for [`FiberBundle`](@ref) when fiber type is a `TVS` of type
[`VectorSpaceType`](https://juliamanifolds.github.io/ManifoldsBase.jl/stable/bases.html#ManifoldsBase.VectorSpaceType).
[`VectorSpaceType`](@ref).
`VectorSpaceFiberType` is used to encode vector spaces as fiber types.
"""
Expand Down

0 comments on commit d77c997

Please sign in to comment.