Skip to content
18

Base Phylogeny

PortfolioOptimisers.AbstractPhylogenyEstimator Type
julia
abstract type AbstractPhylogenyEstimator <: AbstractEstimator

Abstract supertype for all phylogeny estimator types in PortfolioOptimisers.jl.

All concrete and/or abstract types implementing phylogeny-based estimation algorithms should be subtypes of AbstractPhylogenyEstimator.

Related

source
PortfolioOptimisers.AbstractPhylogenyAlgorithm Type
julia
abstract type AbstractPhylogenyAlgorithm <: AbstractAlgorithm

Abstract supertype for all phylogeny algorithm types in PortfolioOptimisers.jl.

All concrete and/or abstract types implementing specific phylogeny algorithms should be subtypes of AbstractPhylogenyAlgorithm.

Related

source
PortfolioOptimisers.AbstractPhylogenyResult Type
julia
abstract type AbstractPhylogenyResult <: AbstractResult

Abstract supertype for all phylogeny result types in PortfolioOptimisers.jl.

All concrete and/or abstract types representing the result of a phylogeny estimation should be subtypes of AbstractPhylogenyResult.

Related

source
PortfolioOptimisers.PlE_Pl Type
julia
const PlE_Pl = Union{<:AbstractPhylogenyEstimator, <:AbstractPhylogenyResult}

Alias for a phylogeny estimator or result.

Matches either an AbstractPhylogenyEstimator or an AbstractPhylogenyResult. Used internally for dispatch when either a phylogeny estimation configuration or pre-computed result is accepted.

Related

source
PortfolioOptimisers.factory Method
julia
factory(
    pl::Union{AbstractPhylogenyEstimator, AbstractPhylogenyResult},
    args...;
    kwargs...
) -> ClustersEstimator{<:CovarianceEstimator, <:AbstractDistanceEstimator, <:AbstractClustersAlgorithm, <:AbstractOptimalNumberClustersEstimator}

Return the phylogeny estimator or result pl unchanged.

Identity pass-through used when a phylogeny estimator or pre-computed result is provided in a context that calls factory.

Related

source
PortfolioOptimisers.factory Method
julia
factory(
    alg::AbstractPhylogenyAlgorithm,
    args...;
    kwargs...
) -> Union{KMeansAlgorithm{var"#s179", Nothing, NamedTuple{names, T}} where {var"#s179"<:AbstractRNG, names, T<:Tuple}, KMeansAlgorithm{var"#s179", var"#s1791", NamedTuple{names, T}} where {var"#s179"<:AbstractRNG, var"#s1791"<:Integer, names, T<:Tuple}}

Return the phylogeny algorithm alg unchanged.

Identity pass-through used when a phylogeny algorithm is provided in a context that calls factory.

Related

source