Skip to content
18

Aliases

These are convenience aliases/functions.

Risk measure aliases

Covariance-based

PortfolioOptimisers.SD Type
julia
SD

Alias for StandardDeviation.

source
PortfolioOptimisers.UcVariance Type
julia
UcVariance

Alias for UncertaintySetVariance.

source

Moment family

PortfolioOptimisers.FLM Function
julia
FLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing) -> LowOrderMoment

Alias for the first Lower Moment (FLM) risk measure LowOrderMoment + FirstLowerMoment.

source
PortfolioOptimisers.MAD Function
julia
MAD(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing) -> LowOrderMoment

Alias for the Mean Absolute Deviation (MAD) risk measure LowOrderMoment + MeanAbsoluteDeviation.

source
PortfolioOptimisers.SCM Function
julia
SCM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing,
      ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing),
      alg::SecondMomentFormulation = SquaredSOCRiskExpr()) -> LowOrderMoment

Alias for the Second Central Moment (SCM) risk measure LowOrderMoment + SecondMoment + FullMoment. This can represent the scenario based variance or standard deviation.

source
PortfolioOptimisers.SLM Function
julia
SLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing,
      ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing),
      alg::SecondMomentFormulation = SquaredSOCRiskExpr()) -> LowOrderMoment

Alias for the Second Lower Moment (SLM) risk measure LowOrderMoment + SecondMoment + SemiMoment. This can represent the scenario based semi-variance or semi-standard deviation.

source
PortfolioOptimisers.ECM Function
julia
ECM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing, p::Integer = 2,
      ddof::Integer = 0) -> LowOrderMoment

Alias for the square root of the central even moment of order 2p LowOrderMoment + EvenMoment + FullMoment.

source
PortfolioOptimisers.ELM Function
julia
ELM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing, p::Integer = 2,
      ddof::Integer = 0) -> LowOrderMoment

Alias for the square root of the lower even moment of order 2p LowOrderMoment + EvenMoment + SemiMoment.

source
PortfolioOptimisers.TLM Function
julia
TLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing) -> HighOrderMoment

Alias for the Third Lower Moment (TLM) risk measure HighOrderMoment + ThirdLowerMoment.

source
PortfolioOptimisers.SSK Function
julia
SSK(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing,
      ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing)) -> HighOrderMoment

Alias for the Standardised Third Lower Moment (SSK) risk measure HighOrderMoment + StandardisedHighOrderMoment + ThirdLowerMoment. This represents the scenario based semi-skewness of the return distribution.

source
PortfolioOptimisers.FTCM Function
julia
FTCM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing) -> HighOrderMoment

Alias for the Fourth Central Moment (FTCM) risk measure HighOrderMoment + FourthMoment + FullMoment.

source
PortfolioOptimisers.FTLM Function
julia
FTLM(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing) -> HighOrderMoment

Alias for the Fourth Lower Moment (FTLM) risk measure HighOrderMoment + FourthMoment + SemiMoment.

source
PortfolioOptimisers.KT Function
julia
KT(; settings::RiskMeasureSettings = RiskMeasureSettings(),
     w::Option{<:ObsWeights} = nothing,
     mu::Option{<:Num_VecNum_VecScalar} = nothing,
     ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing)) -> HighOrderMoment

Alias for the Standardised Fourth Central Moment (KT) risk measure HighOrderMoment + StandardisedHighOrderMoment + FourthMoment + FullMoment. This represents the scenario based kurtosis of the return distribution.

source
PortfolioOptimisers.SKT Function
julia
SKT(; settings::RiskMeasureSettings = RiskMeasureSettings(),
      w::Option{<:ObsWeights} = nothing,
      mu::Option{<:Num_VecNum_VecScalar} = nothing,
      ve::AbstractVarianceEstimator = SimpleVariance(; me = nothing)) -> HighOrderMoment

Alias for the Standardised Fourth Lower Moment (SKT) risk measure HighOrderMoment + StandardisedHighOrderMoment + FourthMoment + SemiMoment. This represents the scenario based semi-kurtosis of the return distribution.

source

Value-at-Risk family

PortfolioOptimisers.WR Type
julia
WR

Alias for WorstRealisation.

source
PortfolioOptimisers.VaR Type
julia
VaR

Alias for ValueatRisk.

source
PortfolioOptimisers.CVaR Type
julia
CVaR

Alias for ConditionalValueatRisk.

source
PortfolioOptimisers.DRCVaR Type
julia
DRCVaR

Alias for DistributionallyRobustConditionalValueatRisk.

source
PortfolioOptimisers.EVaR Type
julia
EVaR

Alias for EntropicValueatRisk.

source
PortfolioOptimisers.RVaR Type
julia
RVaR

Alias for RelativisticValueatRisk.

source
PortfolioOptimisers.PNVaR Type
julia
PNVaR

Alias for PowerNormValueatRisk.

source

Value-at-Risk Range family

PortfolioOptimisers.RG Type
julia
RG

Alias for Range.

source
PortfolioOptimisers.VaR_RG Type
julia
VaR_RG

Alias for ValueatRiskRange.

source
PortfolioOptimisers.CVaR_RG Type
julia
CVaR_RG

Alias for ConditionalValueatRiskRange.

source
PortfolioOptimisers.DRCVaR_RG Type
julia
DRCVaR_RG

Alias for DistributionallyRobustConditionalValueatRiskRange.

source
PortfolioOptimisers.EVaR_RG Type
julia
EVaR_RG

Alias for EntropicValueatRiskRange.

source
PortfolioOptimisers.RVaR_RG Type
julia
RVaR_RG

Alias for RelativisticValueatRiskRange.

source
PortfolioOptimisers.PNVaR_RG Type
julia
PNVaR_RG

Alias for PowerNormValueatRiskRange.

source
PortfolioOptimisers.GVaR_RG Type
julia
GVaR_RG

Alias for GenericValueatRiskRange.

source

Drawdown-at-Risk family

PortfolioOptimisers.DaR Type
julia
DaR

Alias for DrawdownatRisk.

source
PortfolioOptimisers.CDaR Type
julia
CDaR

Alias for ConditionalDrawdownatRisk.

source
PortfolioOptimisers.DRCDaR Type
julia
DRCDaR

Alias for DistributionallyRobustConditionalDrawdownatRisk.

source
PortfolioOptimisers.EDaR Type
julia
EDaR

Alias for EntropicDrawdownatRisk.

source
PortfolioOptimisers.RDaR Type
julia
RDaR

Alias for RelativisticDrawdownatRisk.

source
PortfolioOptimisers.PNDaR Type
julia
PNDaR

Alias for PowerNormDrawdownatRisk.

source
PortfolioOptimisers.R_DaR Type
julia
R_DaR

Alias for RelativeDrawdownatRisk.

source
PortfolioOptimisers.R_CDaR Type
julia
R_CDaR

Alias for RelativeConditionalDrawdownatRisk.

source
PortfolioOptimisers.R_EDaR Type
julia
R_EDaR

Alias for RelativeEntropicDrawdownatRisk.

source
PortfolioOptimisers.R_RDaR Type
julia
R_RDaR

Alias for RelativeRelativisticDrawdownatRisk.

source
PortfolioOptimisers.R_PNDaR Type
julia
R_PNDaR

Alias for RelativePowerNormDrawdownatRisk.

source

Drawdown family

PortfolioOptimisers.ADD Type
julia
ADD

Alias for AverageDrawdown.

source
PortfolioOptimisers.R_ADD Type
julia
R_ADD

Alias for RelativeAverageDrawdown.

source
PortfolioOptimisers.UCI Type
julia
UCI

Alias for UlcerIndex.

source
PortfolioOptimisers.R_UCI Type
julia
R_UCI

Alias for RelativeUlcerIndex.

source
PortfolioOptimisers.MDD Type
julia
MDD

Alias for MaximumDrawdown.

source
PortfolioOptimisers.R_MDD Type
julia
R_MDD

Alias for RelativeMaximumDrawdown.

source

Ordered Weights Array family

PortfolioOptimisers.OWA Type
julia
OWA

Alias for OrderedWeightsArray.

source
PortfolioOptimisers.OWA_GMD Function
julia
OWA_GMD(; settings::RiskMeasureSettings = RiskMeasureSettings(),
          alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Gini Mean Difference (GMD) OrderedWeightsArray risk measure using owa_gmd weights.

source
PortfolioOptimisers.OWA_CVaR Function
julia
OWA_CVaR(; settings::RiskMeasureSettings = RiskMeasureSettings(),
           alpha::Number = 0.05,
           alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Conditional Value at Risk (CVaR) OrderedWeightsArray risk measure using OrderedWeightsArrayConditionalValueatRisk weights at significance level alpha.

source
PortfolioOptimisers.OWA_TG Function
julia
OWA_TG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
         alpha_i::Number = 1e-4,
         alpha::Number = 0.05,
         a_sim::Integer = 100,
         alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Tail Gini (TG) OrderedWeightsArray risk measure using OrderedWeightsArrayTailGini weights.

source
PortfolioOptimisers.OWA_WR Function
julia
OWA_WR(; settings::RiskMeasureSettings = RiskMeasureSettings(),
         alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Worst Realisation (WR) OrderedWeightsArray risk measure using owa_wr weights.

source
PortfolioOptimisers.OWA_RG Function
julia
OWA_RG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
         alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Range (RG) OrderedWeightsArray risk measure using owa_rg weights.

source
PortfolioOptimisers.OWA_CVaR_RG Function
julia
OWA_CVaR_RG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
              alpha::Number = 0.05,
              beta::Number = alpha,
              alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Conditional Value at Risk Range (CVaR RG) OrderedWeightsArray risk measure using OrderedWeightsArrayConditionalValueatRiskRange weights.

source
PortfolioOptimisers.OWA_TG_RG Function
julia
OWA_TG_RG(; settings::RiskMeasureSettings = RiskMeasureSettings(),
            alpha_i::Number = 1e-4,
            alpha::Number = 0.05,
            a_sim::Integer = 100,
            beta_i::Number = alpha_i,
            beta::Number = alpha,
            b_sim::Integer = a_sim,
            alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the Tail Gini Range (TG RG) OrderedWeightsArray risk measure using OrderedWeightsArrayTailGiniRange weights.

source
PortfolioOptimisers.OWA_LMoment Function
julia
OWA_LMoment(; settings::RiskMeasureSettings = RiskMeasureSettings(),
              method::AbstractOrderedWeightsArrayEstimator = NormalisedConstantRelativeRiskAversion(),
              k::Integer = 2,
              alg::OrderedWeightsArrayFormulation = ApproxOrderedWeightsArray()) -> OrderedWeightsArray

Alias for the L-Moment OrderedWeightsArray risk measure using LinearMoment weights of order k.

source

Nonlinear relationships

PortfolioOptimisers.BDVariance Type
julia
BDVariance

Alias for BrownianDistanceVariance.

source

Tracking and turnover

PortfolioOptimisers.TrRM Type
julia
TrRM

Alias for TrackingRiskMeasure.

source
PortfolioOptimisers.RkTrRM Type
julia
RkTrRM

Alias for RiskTrackingRiskMeasure.

source
PortfolioOptimisers.TnRM Type
julia
TnRM

Alias for TurnoverRiskMeasure.

source

Higher-order moments

PortfolioOptimisers.VSK Type
julia
VSK

Alias for VarianceSkewKurtosis.

source

Performance risk measures

PortfolioOptimisers.NonOptRkRatio Type
julia
NonOptRkRatio

Alias for NonOptimisationRiskRatio.

source

Settings

PortfolioOptimisers.RkSet Type
julia
RkSet

Alias for RiskMeasureSettings.

source
PortfolioOptimisers.HRkSet Type
julia
HRkSet

Alias for HierarchicalRiskMeasureSettings.

source

Optimisers

Non-finite optimisers

PortfolioOptimisers.HRP Type
julia
HRP

Alias for HierarchicalRiskParity.

source
PortfolioOptimisers.HERC Type
julia
HERC

Alias for HierarchicalEqualRiskContribution.

source
PortfolioOptimisers.SCHRP Type
julia
SCHRP

Alias for SchurComplementHierarchicalRiskParity.

source
PortfolioOptimisers.MR Type
julia
MR

Alias for MeanRisk.

source
PortfolioOptimisers.RB Type
julia
RB

Alias for RiskBudgeting.

source
PortfolioOptimisers.RRB Type
julia
RRB

Alias for RelaxedRiskBudgeting.

source
PortfolioOptimisers.FRC Type
julia
FRC

Alias for FactorRiskContribution.

source
PortfolioOptimisers.NOC Type
julia
NOC

Alias for NearOptimalCentering.

source
PortfolioOptimisers.NCO Type
julia
NCO

Alias for NestedClustered.

source
PortfolioOptimisers.STO Type
julia
STO

Alias for Stacking.

source
PortfolioOptimisers.SSR Type
julia
SSR

Alias for SubsetResampling.

source
PortfolioOptimisers.JuMPOpt Type
julia
JuMPOpt

Alias for JuMPOptimiser.

source
PortfolioOptimisers.HOpt Type
julia
HOpt

Alias for HierarchicalOptimiser.

source

Finite optimisers

PortfolioOptimisers.DAO Type
julia
DAO

Alias for DiscreteAllocation.

source
PortfolioOptimisers.GAO Type
julia
GAO

Alias for [`GreedyAllocation`](@ref).
source
PortfolioOptimisers.FAI Type
julia
FAI

Alias for FiniteAllocationInput.

source

Moments

PortfolioOptimisers.SmER Type
julia
SmER

Alias for SimpleExpectedReturns.

source
PortfolioOptimisers.GCov Type
julia
GCov

Alias for GeneralCovariance.

source
PortfolioOptimisers.FMoment Type
julia
FMoment

Alias for FullMoment.

source
PortfolioOptimisers.SMoment Type
julia
SMoment

Alias for SemiMoment.

source
PortfolioOptimisers.Cov Type
julia
Cov

Alias for Covariance.

source
PortfolioOptimisers.SVar Type
julia
SVar

Alias for SimpleVariance.

source
PortfolioOptimisers.G0 Type
julia
G0

Alias for Gerber0.

source
PortfolioOptimisers.G1 Type
julia
G1

Alias for Gerber1.

source
PortfolioOptimisers.G2 Type
julia
G2

Alias for Gerber2.

source
PortfolioOptimisers.GerberCov Type
julia
GerberCov

Alias for GerberCovariance.

source
PortfolioOptimisers.SBCov Type
julia
SBCov

Alias for SmythBrobyCovariance.

source
PortfolioOptimisers.SB0 Type
julia
SB0

Alias for SmythBroby0.

source
PortfolioOptimisers.SB1 Type
julia
SB1

Alias for SmythBroby1.

source
PortfolioOptimisers.SB2 Type
julia
SB2

Alias for SmythBroby2.

source
PortfolioOptimisers.SBG0 Type
julia
SBG0

Alias for SmythBrobyGerber0.

source
PortfolioOptimisers.SBG1 Type
julia
SBG1

Alias for SmythBrobyGerber1.

source
PortfolioOptimisers.SBG2 Type
julia
SBG2

Alias for SmythBrobyGerber2.

source
PortfolioOptimisers.SBC0 Type
julia
SBC0

Alias for SmythBrobyCount0.

source
PortfolioOptimisers.SBC1 Type
julia
SBC1

Alias for SmythBrobyCount1.

source
PortfolioOptimisers.SBC2 Type
julia
SBC2

Alias for SmythBrobyCount2.

source
PortfolioOptimisers.DCov Type
julia
DCov

Alias for DistanceCovariance.

source
PortfolioOptimisers.LTDCov Type
julia
LTDCov

Alias for LowerTailDependenceCovariance.

source
PortfolioOptimisers.KCov Type
julia
KCov

Alias for KendallCovariance.

source
PortfolioOptimisers.SCov Type
julia
SCov

Alias for SpearmanCovariance.

source
PortfolioOptimisers.MICov Type
julia
MICov

Alias for MutualInfoCovariance.

source
PortfolioOptimisers.DnCov Function
julia
DnCov

Alias for DenoiseCovariance.

source
PortfolioOptimisers.DtCov Function
julia
DtCov

Alias for DetoneCovariance.

source
PortfolioOptimisers.PrCov Function
julia
PrCov

Alias for ProcessedCovariance.

source
PortfolioOptimisers.POCov Type
julia
POCov

Alias for PortfolioOptimisersCovariance.

source
PortfolioOptimisers.ShER Type
julia
ShER

Alias for ShrunkExpectedReturns.

source
PortfolioOptimisers.GM Type
julia
GM

Alias for GrandMean.

source
PortfolioOptimisers.VW Type
julia
VW

Alias for VolatilityWeighted.

source
PortfolioOptimisers.MSE Type
julia
MSE

Alias for MeanSquaredError.

source
PortfolioOptimisers.JS Type
julia
JS

Alias for JamesStein.

source
PortfolioOptimisers.BS Type
julia
BS

Alias for BayesStein.

source
PortfolioOptimisers.BOP Type
julia
BOP

Alias for BodnarOkhrinParolya.

source
PortfolioOptimisers.EqER Type
julia
EqER

Alias for EquilibriumExpectedReturns.

source
PortfolioOptimisers.ExER Type
julia
ExER

Alias for ExcessExpectedReturns.

source
PortfolioOptimisers.CoSk Type
julia
CoSk

Alias for Coskewness.

source
PortfolioOptimisers.CoKt Type
julia
CoKt

Alias for Cokurtosis.

source
PortfolioOptimisers.LinMod Type
julia
LinMod

Alias for LinearModel.

source
PortfolioOptimisers.GLinMod Type
julia
GLinMod

Alias for GeneralisedLinearModel.

source
PortfolioOptimisers.R2 Type
julia
R2

Alias for RSquared.

source
PortfolioOptimisers.AdjR2 Type
julia
AdjR2

Alias for AdjustedRSquared.

source

Filters

PortfolioOptimisers.ZeroVarianceFilter Function
julia
ZeroVarianceFilter(; tol::Number = 1e-12) -> ScoreSelector

Alias for the zero-variance asset selector ScoreSelector + SCM + ThresholdRule.

Keeps assets whose second central moment strictly exceeds tol, dropping constant and near-constant columns before they reach a prior or an optimiser. The bound is exclusive, so tol = 0 still drops an exactly-constant asset.

Spelled with SCM() rather than Variance: Variance is a WeightsInput risk measure whose functor consumes portfolio weights, so it cannot score a single asset's return series.

Related

source

Preprocessing

PortfolioOptimisers.TTS Type
julia
TTS

Alias for TrainTestSplit.

source

Constraints

PortfolioOptimisers.LCE Type
julia
LCE

Alias for LinearConstraintEstimator.

source
PortfolioOptimisers.WBE Type
julia
WBE

Alias for WeightBoundsEstimator.

source
PortfolioOptimisers.L2Reg Type
julia
L2Reg

Alias for L2Regularisation.

source
PortfolioOptimisers.LpReg Type
julia
LpReg

Alias for LpRegularisation.

source

Objectives

PortfolioOptimisers.MinRk Type
julia
MinRk

Alias for MinimumRisk.

source
PortfolioOptimisers.MaxRt Type
julia
MaxRt

Alias for MaximumReturn.

source
PortfolioOptimisers.MaxUt Type
julia
MaxUt

Alias for MaximumUtility.

source
PortfolioOptimisers.MaxSR Type
julia
MaxSR

Alias for MaximumRatio.

source