tech.nmfin.portfoliooptimization.socp.constraints

Class SOCPLinearBlackList

java.lang.Object

dev.nm.solver.multivariate.constrained.convex.sdp.socp.problem.portfoliooptimization.SOCPPortfolioConstraint

tech.nmfin.portfoliooptimization.socp.constraints.SOCPLinearBlackList

All Implemented Interfaces:

Function<Vector,Double>, RealScalarFunction

public class SOCPLinearBlackList
extends SOCPPortfolioConstraint

A black list means that the positions of some assets must be zero. \[ x_i = 0, \quad \text{for selected indices }i \]

Nested Class Summary

Nested classes/interfaces inherited from class dev.nm.solver.multivariate.constrained.convex.sdp.socp.problem.portfoliooptimization.SOCPPortfolioConstraint

SOCPPortfolioConstraint.ConstraintViolationException, SOCPPortfolioConstraint.Variable

Nested classes/interfaces inherited from interface dev.nm.analysis.function.Function

Function.EvaluationException

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_EPSILON

Constructor Summary

Constructors

Constructor and Description
SOCPLinearBlackList(int nAssets, Collection<Integer> blacklist) Creates a blacklist constraint.
SOCPLinearBlackList(int nAssets, Collection<Integer> blacklist, double epsilon) Creates a blacklist constraint.

Method Summary

Modifier and Type	Method and Description
boolean	areAllConstraintsSatisfied(Vector y) Checks whether all SOCP constraints represented by this portfolio constraint are satisfied.
int	dimensionOfDomain() Get the number of variables the function has.
int	dimensionOfRange() Get the dimension of the range space of the function.
Double	evaluate(Vector x) Evaluate the function f at x, where x is from the domain.

Methods inherited from class dev.nm.solver.multivariate.constrained.convex.sdp.socp.problem.portfoliooptimization.SOCPPortfolioConstraint

generalConstraints, getVariables, linearEqualities, linearInequalities, newSOCPGeneralConstraints, newSOCPLinearEqualities, newSOCPLinearInequalities

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EPSILON

public static final double DEFAULT_EPSILON

See Also:

Constant Field Values

Constructor Detail

SOCPLinearBlackList

public SOCPLinearBlackList(int nAssets,
                           Collection<Integer> blacklist)

Creates a blacklist constraint.

Parameters:

nAssets - the number of assets in the portfolio

blacklist - the indices of the blacklisted asset

SOCPLinearBlackList

public SOCPLinearBlackList(int nAssets,
                           Collection<Integer> blacklist,
                           double epsilon)

Creates a blacklist constraint.

Parameters:

nAssets - the number of assets in the portfolio

blacklist - the indices of the blacklisted asset

epsilon - a precision parameter: when a number |x| ≤ ε, it is considered 0

Method Detail

areAllConstraintsSatisfied

public boolean areAllConstraintsSatisfied(Vector y)
                                   throws SOCPPortfolioConstraint.ConstraintViolationException

Description copied from class: SOCPPortfolioConstraint

Checks whether all SOCP constraints represented by this portfolio constraint are satisfied.

Specified by:

areAllConstraintsSatisfied in class SOCPPortfolioConstraint

Parameters:

y - a portfolio solution or allocation; the asset weights

Returns:

true if and only if all SOCP constraints are satisfied

Throws:

SOCPPortfolioConstraint.ConstraintViolationException

evaluate

public Double evaluate(Vector x)

Description copied from interface: Function

Evaluate the function f at x, where x is from the domain.

Parameters:

x - x

Returns:

f(x)

dimensionOfDomain

public int dimensionOfDomain()

Description copied from interface: Function

Get the number of variables the function has. For example, for a univariate function, the domain dimension is 1; for a bivariate function, the domain dimension is 2.

Returns:

the number of variables

dimensionOfRange

public int dimensionOfRange()

Description copied from interface: Function

Get the dimension of the range space of the function. For example, for a \(R^{n}\to R^{m}\) function, the dimension of the range is m.

Returns:

the dimension of the range