Type hierarchy

The trees below are generated automatically from the live type hierarchy every time the documentation is built (see [docs/generate_type_hierarchy.jl](https://github.com/dcelisgarza/PortfolioOptimisers.jl/tree/main/docs/generate_type_hierarchy.jl)), so they always reflect the current state of the package. Each type links to its docstring.

AbstractResult

├── AbstractConstraintResult

│ ├── AbstractParsingResult

│ │ ├── ParsingResult

│ │ └── RhoParsingResult

│ ├── AbstractPhylogenyConstraintResult

│ │ ├── IntegerPhylogeny

│ │ └── SemiDefinitePhylogeny

│ ├── LinearConstraint

│ ├── PartialLinearConstraint

│ ├── RiskBudget

│ ├── Threshold

│ └── WeightBounds

├── AbstractJuMPResult

│ └── JuMPResult

├── AbstractPhylogenyResult

│ ├── AbstractClusteringResult

│ │ └── Clusters

│ └── PhylogenyResult

├── AbstractPredictionResult

│ ├── MultiPeriodPredictionResult

│ ├── PopulationPredictionResult

│ └── PredictionResult

├── AbstractPriorResult

│ ├── HighOrderPrior

│ └── LowOrderPrior

├── AbstractRegressionResult

│ └── Regression

├── AbstractReturnsResult

│ ├── PredictionReturnsResult

│ └── ReturnsResult

├── AbstractSearchCrossValidationResult

│ └── SearchCrossValidationResult

├── AbstractTracking

│ ├── RiskTrackingError

│ └── TrackingError

├── AbstractUncertaintySetResult

│ ├── AbstractEllipsoidalUncertaintySetResultClass

│ │ ├── MuEllipsoidalUncertaintySet

│ │ └── SigmaEllipsoidalUncertaintySet

│ ├── BoxUncertaintySet

│ └── EllipsoidalUncertaintySet

├── BaseJuMPOptimisationResult

│ └── JuMPOptimisationResult

├── BlackLittermanViews

├── ClusterNode

├── CrossValidationResult

│ ├── NonOptimisationCrossValidationResult

│ │ ├── NonOptimisationNonSequentialCrossValidationResult

│ │ └── NonOptimisationSequentialCrossValidationResult

│ │ └── MultipleRandomisedResult

│ └── OptimisationCrossValidationResult

│ ├── NonSequentialCrossValidationResult

│ │ ├── CombinatorialCrossValidationResult

│ │ └── KFoldResult

│ └── SequentialCrossValidationResult

│ └── WalkForwardResult

├── Fees

├── NearOptimalSetup

├── OptimisationModelResult

│ └── JuMPOptimisationSolution

├── OptimisationResult

│ ├── FiniteAllocationOptimisationResult

│ │ ├── DiscreteAllocationResult

│ │ └── GreedyAllocationResult

│ └── NonFiniteAllocationOptimisationResult

│ ├── NonJuMPOptimisationResult

│ │ ├── HierarchicalResult

│ │ ├── NaiveOptimisationResult

│ │ ├── NestedClusteredResult

│ │ ├── SchurComplementHierarchicalRiskParityResult

│ │ ├── StackingResult

│ │ └── SubsetResamplingResult

│ └── RiskJuMPOptimisationResult

│ ├── FactorRiskContributionResult

│ ├── MeanRiskResult

│ ├── NearOptimalCenteringResult

│ └── RiskBudgetingResult

├── OptimisationReturnCode

│ ├── OptimisationFailure

│ └── OptimisationSuccess

├── ProcessedAssetRiskBudgetingAttributes

├── ProcessedFactorRiskBudgetingAttributes

├── ProcessedJuMPOptimiserAttributes

├── RegimeAdjustedVarianceCache

├── Turnover

└── VecScalar

AbstractEstimator

AbstractEstimator

├── AbstractBaseRiskMeasure

│ ├── NonOptimisationRiskMeasure

│ │ ├── ExpectedReturn

│ │ ├── ExpectedReturnRiskRatio

│ │ ├── MeanReturn

│ │ ├── MeanReturnRiskRatio

│ │ ├── NonOptimisationRiskRatioRiskMeasure

│ │ ├── Skewness

│ │ └── ThirdCentralMoment

│ └── OptimisationRiskMeasure

│ ├── HierarchicalRiskMeasure

│ │ ├── EqualRiskMeasure

│ │ ├── HighOrderMoment

│ │ ├── MedianAbsoluteDeviation

│ │ ├── RelativeAverageDrawdown

│ │ ├── RelativeConditionalDrawdownatRisk

│ │ ├── RelativeDrawdownatRisk

│ │ ├── RelativeEntropicDrawdownatRisk

│ │ ├── RelativeMaximumDrawdown

│ │ ├── RelativePowerNormDrawdownatRisk

│ │ ├── RelativeRelativisticDrawdownatRisk

│ │ ├── RelativeUlcerIndex

│ │ └── RiskRatioRiskMeasure

│ └── RiskMeasure

│ ├── AverageDrawdown

│ ├── BrownianDistanceVariance

│ ├── ConditionalDrawdownatRisk

│ ├── ConditionalValueatRisk

│ ├── ConditionalValueatRiskRange

│ ├── DistributionallyRobustConditionalDrawdownatRisk

│ ├── DistributionallyRobustConditionalValueatRisk

│ ├── DistributionallyRobustConditionalValueatRiskRange

│ ├── DrawdownatRisk

│ ├── EntropicDrawdownatRisk

│ ├── EntropicValueatRisk

│ ├── EntropicValueatRiskRange

│ ├── Kurtosis

│ ├── LowOrderMoment

│ ├── MaximumDrawdown

│ ├── NegativeSkewness

│ ├── OrderedWeightsArray

│ ├── OrderedWeightsArrayRange

│ ├── PowerNormDrawdownatRisk

│ ├── PowerNormValueatRisk

│ ├── PowerNormValueatRiskRange

│ ├── Range

│ ├── RelativisticDrawdownatRisk

│ ├── RelativisticValueatRisk

│ ├── RelativisticValueatRiskRange

│ ├── RiskTrackingRiskMeasure

│ ├── StandardDeviation

│ ├── TrackingRiskMeasure

│ ├── TurnoverRiskMeasure

│ ├── UlcerIndex

│ ├── UncertaintySetVariance

│ ├── ValueatRisk

│ ├── ValueatRiskRange

│ ├── Variance

│ ├── VarianceSkewKurtosis

│ └── WorstRealisation

├── AbstractCentralityEstimator

│ └── CentralityEstimator

├── AbstractConstraintEstimator

│ ├── AbstractCentralityConstraint

│ │ └── CentralityConstraint

│ ├── AbstractPhylogenyConstraintEstimator

│ │ ├── IntegerPhylogenyEstimator

│ │ └── SemiDefinitePhylogenyEstimator

│ ├── AssetSetsMatrixEstimator

│ ├── JuMPConstraintEstimator

│ │ ├── BudgetConstraintEstimator

│ │ │ ├── BudgetCostEstimator

│ │ │ │ ├── BudgetCosts

│ │ │ │ └── BudgetMarketImpact

│ │ │ └── BudgetEstimator

│ │ │ └── BudgetRange

│ │ ├── CustomJuMPConstraint

│ │ └── CustomJuMPObjective

│ ├── LinearConstraintEstimator

│ ├── RiskBudgetEstimator

│ ├── ThresholdEstimator

│ └── WeightBoundsEstimator

├── AbstractCrossValidationScorer

│ ├── PopulationScorer

│ └── PredictionScorer

│ └── NearestQuantilePrediction

├── AbstractDenoiseEstimator

│ └── Denoise

├── AbstractDetoneEstimator

│ └── Detone

├── AbstractDistanceEstimator

│ ├── Distance

│ └── DistanceDistance

├── AbstractEntropyPoolingOptimiser

│ ├── CVaREntropyPooling

│ ├── JuMPEntropyPooling

│ └── OptimEntropyPooling

├── AbstractExpectedReturnsEstimator

│ ├── AbstractShrunkExpectedReturnsEstimator

│ │ ├── EquilibriumExpectedReturns

│ │ ├── ExcessExpectedReturns

│ │ └── ShrunkExpectedReturns

│ ├── CustomValueExpectedReturns

│ ├── MedianExpectedReturns

│ ├── SimpleExpectedReturns

│ ├── StandardDeviationExpectedReturns

│ ├── VarianceExpectedReturns

│ └── WindowedExpectedReturns

├── AbstractMatrixProcessingEstimator

│ └── MatrixProcessing

├── AbstractOptimalNumberClustersEstimator

│ └── OptimalNumberClusters

├── AbstractOptimisationEstimator

│ ├── BaseOptimisationEstimator

│ │ ├── BaseClusteringOptimisationEstimator

│ │ │ └── HierarchicalOptimiser

│ │ └── BaseJuMPOptimisationEstimator

│ │ └── JuMPOptimiser

│ └── OptimisationEstimator

│ ├── FiniteAllocationOptimisationEstimator

│ │ ├── DiscreteAllocation

│ │ └── GreedyAllocation

│ └── NonFiniteAllocationOptimisationEstimator

│ ├── BaseStackingOptimisationEstimator

│ │ └── Stacking

│ ├── BaseSubsetResamplingOptimisationEstimator

│ │ └── SubsetResampling

│ ├── ClusteringOptimisationEstimator

│ │ ├── HierarchicalEqualRiskContribution

│ │ ├── HierarchicalRiskParity

│ │ ├── NestedClustered

│ │ └── SchurComplementHierarchicalRiskParity

│ ├── JuMPOptimisationEstimator

│ │ ├── RelaxedRiskBudgeting

│ │ └── RiskJuMPOptimisationEstimator

│ │ ├── FactorRiskContribution

│ │ ├── MeanRisk

│ │ ├── NearOptimalCentering

│ │ └── RiskBudgeting

│ └── NaiveOptimisationEstimator

│ ├── EqualWeighted

│ ├── InverseVolatility

│ └── RandomWeighted

├── AbstractOrderedWeightsArrayEstimator

│ ├── NormalisedConstantRelativeRiskAversion

│ └── OWAJuMP

├── AbstractPhylogenyEstimator

│ ├── AbstractClustersEstimator

│ │ ├── ClustersEstimator

│ │ └── NetworkClustersEstimator

│ └── AbstractNetworkEstimator

│ └── NetworkEstimator

├── AbstractPosdefEstimator

│ └── Posdef

├── AbstractPriorEstimator

│ ├── AbstractHighOrderPriorEstimator

│ │ ├── AbstractHighOrderPriorEstimator_F

│ │ │ └── HighOrderFactorPriorEstimator

│ │ └── HighOrderPriorEstimator

│ └── AbstractLowOrderPriorEstimator

│ ├── AbstractLowOrderPriorEstimator_A

│ │ └── EmpiricalPrior

│ ├── AbstractLowOrderPriorEstimator_AF

│ │ ├── BlackLittermanPrior

│ │ ├── EntropyPoolingPrior

│ │ └── OpinionPoolingPrior

│ └── AbstractLowOrderPriorEstimator_F

│ ├── AugmentedBlackLittermanPrior

│ ├── BayesianBlackLittermanPrior

│ ├── FactorBlackLittermanPrior

│ └── FactorPrior

├── AbstractRegressionEstimator

│ ├── DimensionReductionRegression

│ └── StepwiseRegression

├── AbstractRegularisationEstimator

│ └── LpRegularisation

├── AbstractRiskMeasureSettings

│ ├── HierarchicalRiskMeasureSettings

│ └── JuMPRiskMeasureSettings

│ ├── MaxRiskMeasureSettings

│ └── RiskMeasureSettings

├── AbstractSearchCrossValidationEstimator

│ ├── GridSearchCrossValidation

│ └── RandomisedSearchCrossValidation

├── AbstractUncertaintySetEstimator

│ ├── BootstrapUncertaintySetEstimator

│ │ └── ARCHUncertaintySet

│ ├── DeltaUncertaintySet

│ └── NormalUncertaintySet

├── AssetSets

├── CokurtosisEstimator

│ ├── Cokurtosis

│ └── WindowedCokurtosis

├── CoskewnessEstimator

│ ├── Coskewness

│ └── WindowedCoskewness

├── CrossValidationEstimator

│ ├── NonOptimisationCrossValidationEstimator

│ │ ├── NonOptimisationNonSequentialCrossValidationEstimator

│ │ └── NonOptimisationSequentialCrossValidationEstimator

│ │ └── MultipleRandomised

│ └── OptimisationCrossValidationEstimator

│ ├── NonSequentialCrossValidationEstimator

│ │ ├── CombinatorialCrossValidation

│ │ └── KFold

│ └── SequentialCrossValidationEstimator

│ └── WalkForwardEstimator

│ ├── DateWalkForward

│ └── IndexWalkForward

├── CrossValidationSearchScorer

│ └── HighestMeanScore

├── DateAdjusterEstimator

├── DynamicAbstractWeights

├── FeesEstimator

├── FrontierBoundEstimator

│ ├── LinearBound

│ ├── SquareRootBound

│ └── SquaredBound

├── GerberIQDecayEstimator

│ └── ExpGerberIQDecay

├── GerberIQEpsEstimator

├── GerberIQGammaEstimator

├── GerberIQScalerEstimator

│ └── AssetVolatilityGerberIQScaler

├── JuMPReturnsEstimator

│ ├── ArithmeticReturn

│ └── LogarithmicReturn

├── NumberSubsetsEstimator

├── ObjectiveFunction

│ ├── MaximumRatio

│ ├── MaximumReturn

│ ├── MaximumUtility

│ └── MinimumRisk

├── OptimisationCrossValidation

├── RegimeAdjustedMethod

│ ├── FirstMomentRegimeAdjusted

│ ├── LogRegimeAdjusted

│ └── RootMeanSquaredAdjusted

├── Scalariser

│ ├── HierarchicalScalariser

│ │ └── MinScalariser

│ └── NonHierarchicalScalariser

│ ├── LogSumExpScalariser

│ ├── MaxScalariser

│ └── SumScalariser

├── Solver

├── SubsetSizeEstimator

├── TurnoverEstimator

└── WindowSizeEstimator

AbstractAlgorithm

AbstractAlgorithm

├── ARCHBootstrapSet

│ ├── CircularBootstrap

│ ├── MovingBootstrap

│ └── StationaryBootstrap

├── AbstractBins

│ ├── AstroPyBins

│ │ ├── FreedmanDiaconis

│ │ ├── Knuth

│ │ └── Scott

│ └── HacineGharbiRavier

├── AbstractDenoiseAlgorithm

│ ├── FixedDenoise

│ ├── ShrunkDenoise

│ └── SpectralDenoise

├── AbstractDistanceAlgorithm

│ ├── CanonicalDistance

│ ├── CorrelationDistance

│ ├── LogDistance

│ ├── SimpleAbsoluteDistance

│ ├── SimpleDistance

│ └── VariationInfoDistance

├── AbstractEntropyPoolingAlgorithm

│ ├── H0_EntropyPooling

│ ├── H1_EntropyPooling

│ └── H2_EntropyPooling

├── AbstractEntropyPoolingOptAlgorithm

│ ├── ExpEntropyPooling

│ └── LogEntropyPooling

├── AbstractEstimatorValueAlgorithm

│ └── UniformValues

├── AbstractExpectedReturnsAlgorithm

│ ├── AbstractShrunkExpectedReturnsAlgorithm

│ │ ├── BayesStein

│ │ ├── BodnarOkhrinParolya

│ │ └── JamesStein

│ └── AbstractShrunkExpectedReturnsTarget

│ ├── GrandMean

│ ├── MeanSquaredError

│ └── VolatilityWeighted

├── AbstractMatrixProcessingAlgorithm

│ └── InverseMatrixSparsificationAlgorithm

│ └── LoGo

├── AbstractMomentAlgorithm

│ ├── Full

│ ├── GerberCovarianceAlgorithm

│ │ ├── Gerber0

│ │ ├── Gerber1

│ │ └── Gerber2

│ ├── GerberIQCovarianceAlgorithm

│ │ ├── BasicGerberIQ

│ │ ├── FullGerberIQ

│ │ └── PartialGerberIQ

│ ├── Semi

│ └── SmythBrobyCovarianceAlgorithm

│ ├── SmythBroby0

│ ├── SmythBroby1

│ ├── SmythBroby2

│ ├── SmythBrobyCount0

│ ├── SmythBrobyCount1

│ ├── SmythBrobyCount2

│ ├── SmythBrobyGerber0

│ ├── SmythBrobyGerber1

│ └── SmythBrobyGerber2

├── AbstractOptimalNumberClustersAlgorithm

│ ├── SecondOrderDifference

│ └── SilhouetteScore

├── AbstractOrderedWeightsArrayAlgorithm

│ ├── MaximumEntropy

│ └── SquaredOrderedWeightsArrayAlgorithm

│ ├── MinimumSquaredDistance

│ └── MinimumSumSquares

├── AbstractPhylogenyAlgorithm

│ ├── AbstractCentralityAlgorithm

│ │ ├── BetweennessCentrality

│ │ ├── ClosenessCentrality

│ │ ├── DegreeCentrality

│ │ ├── EigenvectorCentrality

│ │ ├── KatzCentrality

│ │ ├── Pagerank

│ │ ├── RadialityCentrality

│ │ └── StressCentrality

│ ├── AbstractClustersAlgorithm

│ │ ├── AbstractHierarchicalClusteringAlgorithm

│ │ │ ├── DBHT

│ │ │ └── HClustAlgorithm

│ │ └── AbstractNonHierarchicalClusteringAlgorithm

│ │ └── KMeansAlgorithm

│ └── AbstractTreeType

│ ├── BoruvkaTree

│ ├── KruskalTree

│ └── PrimTree

├── AbstractPreorderBy

│ └── PreorderTreeByID

├── AbstractRegressionAlgorithm

│ ├── AbstractRegressionTarget

│ │ ├── GeneralisedLinearModel

│ │ └── LinearModel

│ ├── AbstractStepwiseRegressionAlgorithm

│ │ ├── Backward

│ │ └── Forward

│ ├── AbstractStepwiseRegressionCriterion

│ │ ├── AbstractMinMaxValStepwiseRegressionCriterion

│ │ │ ├── AbstractMaxValStepwiseRegressionCriteria

│ │ │ │ ├── AdjustedRSquared

│ │ │ │ └── RSquared

│ │ │ └── AbstractMinValStepwiseRegressionCriterion

│ │ │ ├── AIC

│ │ │ ├── AICC

│ │ │ └── BIC

│ │ └── PValue

│ └── DimensionReductionTarget

│ ├── PCA

│ └── PPCA

├── AbstractSearchCrossValidationAlgorithm

├── AbstractSimilarityMatrixAlgorithm

│ ├── ExponentialSimilarity

│ ├── GeneralExponentialSimilarity

│ └── MaximumDistanceSimilarity

├── AbstractTrackingAlgorithm

│ ├── ReturnsTracking

│ └── WeightsTracking

├── AbstractUncertaintyKAlgorithm

│ ├── ChiSqKUncertaintyAlgorithm

│ ├── GeneralKUncertaintyAlgorithm

│ └── NormalKUncertaintyAlgorithm

├── AbstractUncertaintySetAlgorithm

│ ├── BoxUncertaintySetAlgorithm

│ └── EllipsoidalUncertaintySetAlgorithm

├── BrownianDistanceVarianceFormulation

│ ├── IneqBrownianDistanceVariance

│ └── NormOneConeBrownianDistanceVariance

├── CrossValidationAlgorithm

├── DBHTRootMethod

│ ├── EqualRoot

│ └── UniqueRoot

├── EntropyFormulation

│ ├── ExponentialConeEntropy

│ └── RelativeEntropy

├── Frontier

├── ImpliedVolatilityAlgorithm

│ ├── ImpliedVolatilityPremium

│ └── ImpliedVolatilityRegression

├── JuMPWeightFinaliserFormulation

│ ├── AbsoluteErrorWeightFinaliser

│ ├── RelativeErrorWeightFinaliser

│ ├── SquaredAbsoluteErrorWeightFinaliser

│ └── SquaredRelativeErrorWeightFinaliser

├── MedianCenteringFunction

│ ├── MeanCentering

│ └── MedianCentering

├── MomentMeasureAlgorithm

│ ├── HighOrderMomentMeasureAlgorithm

│ │ ├── StandardisedHighOrderMoment

│ │ └── UnstandardisedHighOrderMomentMeasureAlgorithm

│ │ ├── FourthMoment

│ │ └── ThirdLowerMoment

│ └── LowOrderMomentMeasureAlgorithm

│ ├── SecondMoment

│ └── UnstandardisedLowOrderMomentMeasureAlgorithm

│ ├── EvenMoment

│ ├── FirstLowerMoment

│ └── MeanAbsoluteDeviation

├── OpinionPoolingAlgorithm

│ ├── LinearOpinionPooling

│ └── LogarithmicOpinionPooling

├── OptimisationAlgorithm

│ ├── NearOptimalCenteringAlgorithm

│ │ ├── ConstrainedNearOptimalCentering

│ │ └── UnconstrainedNearOptimalCentering

│ ├── RelaxedRiskBudgetingAlgorithm

│ │ ├── BasicRelaxedRiskBudgeting

│ │ ├── RegularisedPenalisedRelaxedRiskBudgeting

│ │ └── RegularisedRelaxedRiskBudgeting

│ ├── RiskBudgetingAlgorithm

│ │ ├── AssetRiskBudgeting

│ │ └── FactorRiskBudgeting

│ └── RiskBudgetingFormulation

│ ├── LogRiskBudgeting

│ └── MixedIntegerRiskBudgeting

├── OrderedWeightsArrayFormulation

│ ├── ApproxOrderedWeightsArray

│ └── ExactOrderedWeightsArray

├── RegimeAdjustedTarget

│ ├── DiagonalTarget

│ ├── MahalanobisTarget

│ └── PortfolioTarget

├── SchurComplementAlgorithm

│ ├── MonotonicSchurComplement

│ └── NonMonotonicSchurComplement

├── SchurComplementParams

├── SecondMomentFormulation

│ ├── RSOCRiskExpr

│ ├── SOCRiskExpr

│ └── VarianceFormulation

│ ├── QuadRiskExpr

│ └── SquaredSOCRiskExpr

├── TrackingFormulation

│ ├── NormTracking

│ │ ├── L1Tracking

│ │ ├── L2Tracking

│ │ ├── LInfTracking

│ │ ├── LpTracking

│ │ └── SquaredL2Tracking

│ └── VariableTracking

│ ├── DependentVariableTracking

│ └── IndependentVariableTracking

├── ValueatRiskFormulation

│ ├── DistributionValueatRisk

│ └── MIPValueatRisk

├── VectorToScalarMeasure

│ ├── MaxValue

│ ├── MeanValue

│ ├── MedianValue

│ ├── MinValue

│ ├── ModeValue

│ ├── ProdValue

│ ├── StandardisedValue

│ ├── StdValue

│ ├── SumValue

│ └── VarValue

└── WeightFinaliser

├── IterativeWeightFinaliser

└── JuMPWeightFinaliser

AbstractCovarianceEstimator

AbstractCovarianceEstimator

├── AbstractVarianceEstimator

│ ├── SimpleVariance

│ └── WindowedVariance

├── BaseGerberCovariance

│ ├── BaseGerberIQCovariance

│ │ └── GerberIQCovariance

│ ├── BaseSmythBrobyCovariance

│ │ └── SmythBrobyCovariance

│ └── GerberCovariance

├── CorrelationCovariance

├── Covariance

├── DenoiseCovariance

├── DetoneCovariance

├── DistanceCovariance

├── GeneralCovariance

├── ImpliedVolatility

├── LowerTailDependenceCovariance

├── MutualInfoCovariance

├── PortfolioOptimisersCovariance

├── ProcessedCovariance

├── RankCovarianceEstimator

│ ├── KendallCovariance

│ └── SpearmanCovariance

├── RegimeAdjustedExpWeightedCovariance

├── RegimeAdjustedExpWeightedVariance

└── WindowedCovariance