org.ojalgo.finance.portfolio

Class EfficientFrontier

java.lang.Object

org.ojalgo.finance.portfolio.FinancePortfolio

org.ojalgo.finance.portfolio.EfficientFrontier

All Implemented Interfaces:

Comparable<FinancePortfolio>, FinancePortfolio.Context

public final class EfficientFrontier
extends FinancePortfolio

Represents a portfolio on the efficient fronter. You get different efficient portfolios by altering the risk aversion.

Author:

apete

Nested Class Summary

Nested classes/interfaces inherited from class org.ojalgo.finance.portfolio.FinancePortfolio

FinancePortfolio.Context

Field Summary

Fields inherited from class org.ojalgo.finance.portfolio.FinancePortfolio

MATRIX_FACTORY

Constructor Summary

Constructors

Constructor and Description
EfficientFrontier(BasicMatrix covarianceMatrix, BasicMatrix expectedExcessReturns)
EfficientFrontier(FinancePortfolio.Context portfolioContext)
EfficientFrontier(MarketEquilibrium marketEquilibrium, BasicMatrix expectedExcessReturns)

Method Summary

Modifier and Type	Method and Description
protected BasicMatrix	calculateAssetReturns()
protected BasicMatrix	calculateAssetReturns(BasicMatrix aWeightsVctr)
protected BasicMatrix	calculateAssetWeights()
protected BasicMatrix	calculateAssetWeights(BasicMatrix aReturnsVctr)
protected Scalar<?>	calculatePortfolioReturn(BasicMatrix aWeightsVctr, BasicMatrix aReturnsVctr)
double	calculatePortfolioReturn(FinancePortfolio weightsPortfolio)
protected Scalar<?>	calculatePortfolioVariance(BasicMatrix aWeightsVctr)
double	calculatePortfolioVariance(FinancePortfolio weightsPortfolio)
protected void	calibrate(BasicMatrix aWeightsVctr, BasicMatrix aReturnsVctr)
BasicMatrix	getAssetReturns()
BasicMatrix	getAssetVolatilities()
BasicMatrix	getAssetWeights()
BasicMatrix	getCorrelations()
BasicMatrix	getCovariances()
MarketEquilibrium	getMarketEquilibrium()
double	getMeanReturn() The mean/expected return of this instrument.
double	getReturnVariance() The instrument's return variance.
Scalar<?>	getRiskAversion()
String[]	getSymbols()
List<BigDecimal>	getWeights() This method returns a list of the weights of the Portfolio's contained assets.
protected BasicMatrix	handle(Optimisation.Result optimisationResult)
boolean	isShortingAllowed()
org.ojalgo.finance.portfolio.OptimisedPortfolio.Optimiser	optimiser()
protected void	reset()
void	setRiskAversion(Number factor)
void	setShortingAllowed(boolean allowed)
int	size()
List<SimpleAsset>	toSimpleAssets()
SimplePortfolio	toSimplePortfolio()
String	toString()

Methods inherited from class org.ojalgo.finance.portfolio.FinancePortfolio

compareTo, forecast, getConformance, getLossProbability, getLossProbability, getSharpeRatio, getSharpeRatio, getValueAtRisk, getValueAtRisk95, getVolatility, normalise, normalise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EfficientFrontier

public EfficientFrontier(BasicMatrix covarianceMatrix,
                         BasicMatrix expectedExcessReturns)

EfficientFrontier

public EfficientFrontier(FinancePortfolio.Context portfolioContext)

EfficientFrontier

public EfficientFrontier(MarketEquilibrium marketEquilibrium,
                         BasicMatrix expectedExcessReturns)

Method Detail

calculateAssetWeights

protected BasicMatrix calculateAssetWeights()

reset

protected void reset()

isShortingAllowed

public final boolean isShortingAllowed()

optimiser

public org.ojalgo.finance.portfolio.OptimisedPortfolio.Optimiser optimiser()

setShortingAllowed

public final void setShortingAllowed(boolean allowed)

calculateAssetReturns

protected final BasicMatrix calculateAssetReturns()

handle

protected final BasicMatrix handle(Optimisation.Result optimisationResult)

calculatePortfolioReturn

public final double calculatePortfolioReturn(FinancePortfolio weightsPortfolio)

Specified by:

calculatePortfolioReturn in interface FinancePortfolio.Context

calculatePortfolioVariance

public final double calculatePortfolioVariance(FinancePortfolio weightsPortfolio)

Specified by:

calculatePortfolioVariance in interface FinancePortfolio.Context

getAssetReturns

public final BasicMatrix getAssetReturns()

Specified by:

getAssetReturns in interface FinancePortfolio.Context

getAssetVolatilities

public final BasicMatrix getAssetVolatilities()

Specified by:

getAssetVolatilities in interface FinancePortfolio.Context

getAssetWeights

public final BasicMatrix getAssetWeights()

getCorrelations

public final BasicMatrix getCorrelations()

Specified by:

getCorrelations in interface FinancePortfolio.Context

getCovariances

public final BasicMatrix getCovariances()

Specified by:

getCovariances in interface FinancePortfolio.Context

getMarketEquilibrium

public final MarketEquilibrium getMarketEquilibrium()

getMeanReturn

public final double getMeanReturn()

Description copied from class: FinancePortfolio

The mean/expected return of this instrument. May return either the absolute or excess return of the instrument. The context in which an instance is used should make it clear which. return.

Specified by:

getMeanReturn in class FinancePortfolio

getReturnVariance

public final double getReturnVariance()

Description copied from class: FinancePortfolio

The instrument's return variance. Subclasses must override either FinancePortfolio.getReturnVariance() or FinancePortfolio.getVolatility().

Overrides:

getReturnVariance in class FinancePortfolio

getRiskAversion

public final Scalar<?> getRiskAversion()

getSymbols

public final String[] getSymbols()

getWeights

public final List<BigDecimal> getWeights()

Description copied from class: FinancePortfolio

This method returns a list of the weights of the Portfolio's contained assets. An asset weight is NOT restricted to being a share/percentage - it can be anything. Most subclasses do however assume that the list of asset weights are shares/percentages that sum up to 100%. Calling FinancePortfolio.normalise() will transform any set of weights to that form.

Specified by:

getWeights in class FinancePortfolio

setRiskAversion

public final void setRiskAversion(Number factor)

size

public int size()

Specified by:

size in interface FinancePortfolio.Context

toSimpleAssets

public final List<SimpleAsset> toSimpleAssets()

toSimplePortfolio

public final SimplePortfolio toSimplePortfolio()

toString

public String toString()

Overrides:

toString in class FinancePortfolio

calculateAssetReturns

protected final BasicMatrix calculateAssetReturns(BasicMatrix aWeightsVctr)

calculateAssetWeights

protected final BasicMatrix calculateAssetWeights(BasicMatrix aReturnsVctr)

calculatePortfolioReturn

protected final Scalar<?> calculatePortfolioReturn(BasicMatrix aWeightsVctr,
                                                   BasicMatrix aReturnsVctr)

calculatePortfolioVariance

protected final Scalar<?> calculatePortfolioVariance(BasicMatrix aWeightsVctr)

calibrate

protected final void calibrate(BasicMatrix aWeightsVctr,
                               BasicMatrix aReturnsVctr)