Main Content

getEquality

Obtain equality constraint arrays from portfolio object

collapse all in page

Syntax

[AEquality,bEquality] = getEquality(obj)

Description

Use the getEquality function with a Portfolio, PortfolioCVaR, or PortfolioMAD object to obtain equality constraint arrays from portfolio objects.

For details on the respective workflows when using these different objects, see Portfolio Object Workflow, PortfolioCVaR Object Workflow, and PortfolioMAD Object Workflow.

[AEquality,bEquality] = getEquality(obj) obtains equality constraint arrays from portfolio objects.

example

Examples

collapse all

Open Live Script

Suppose you have a portfolio of five assets and you want to ensure that the first three assets are exactly 50% of your portfolio. Given a Portfolio object p, set the linear equality constraints and obtain the values for AEquality and bEquality: 

A = [ 1 1 1 0 0 ];
b = 0.5;
p = Portfolio;
p = setEquality(p, A, b);
[AEquality, bEquality] = getEquality(p)
AEquality = 1×5

     1     1     1     0     0


bEquality = 
0.5000
Open Live Script

Suppose you have a portfolio of five assets and you want to ensure that the first three assets are 50% of your portfolio. Given a PortfolioCVaR object p, set the linear equality constraints and obtain the values for AEquality and bEquality: 

A = [ 1 1 1 0 0 ];
b = 0.5;
p = PortfolioCVaR;
p = setEquality(p, A, b);
[AEquality, bEquality] = getEquality(p)
AEquality = 1×5

     1     1     1     0     0


bEquality = 
0.5000
Open Live Script

Suppose you have a portfolio of five assets and you want to ensure that the first three assets are 50% of your portfolio. Given a PortfolioMAD object p, set the linear equality constraints and obtain the values for AEquality and bEquality:

A = [ 1 1 1 0 0 ];
b = 0.5;
p = PortfolioMAD;
p = setEquality(p, A, b);
[AEquality, bEquality] = getEquality(p)
AEquality = 1×5

     1     1     1     0     0


bEquality = 
0.5000

Input Arguments

collapse all

Object for portfolio, specified using Portfolio, PortfolioCVaR, or PortfolioMAD object. For more information on creating a portfolio object, see

Data Types: object

Output Arguments

collapse all

Matrix to form linear equality constraints, returned as a matrix for a Portfolio, PortfolioCVaR, or PortfolioMAD input object (obj).

Vector to form linear equality constraints, returned as a vector for a Portfolio, PortfolioCVaR, or PortfolioMAD input object (obj).

Tips

You can also use dot notation to obtain the equality constraint arrays from portfolio objects.

[AEquality, bEquality] = obj.getEquality;

Version History

Introduced in R2011a

See Also

Topics