Phylogeny Constraints: private API

abstract type AbstractCentralityConstraint <: AbstractConstraintEstimator

Abstract supertype for all centrality-based constraint types.

All concrete types implementing centrality-based portfolio constraints should be subtypes of AbstractCentralityConstraint.

A subtype states a bound on a linear function of the weights whose coefficients come from a graph, so centrality_constraints reduces it to a LinearConstraint before the model sees it.

Related

• CentralityConstraint
• AbstractConstraintEstimator
• centrality_constraints
• LinearConstraint

const VecCC = AbstractVector{<:CentralityConstraint}

Alias for a vector of CentralityConstraint objects.

Represents a collection of centrality-based portfolio constraints.

Related

• CentralityConstraint
• CC_VecCC

const CC_VecCC = Union{<:CentralityConstraint, <:VecCC}

Alias for a single or vector of CentralityConstraint objects.

Matches either a single CentralityConstraint or a vector of them (VecCC).

Related

• CentralityConstraint
• VecCC

abstract type AbstractPhylogenyConstraintEstimator <: AbstractConstraintEstimator

Abstract supertype for all phylogeny-based constraint estimators.

All concrete and/or abstract types representing phylogeny-based constraint estimators should be subtypes of AbstractPhylogenyConstraintEstimator.

Related

• SemiDefinitePhylogenyEstimator
• IntegerPhylogenyEstimator
• CentralityConstraint
• AbstractConstraintEstimator

abstract type AbstractPhylogenyConstraintResult <: AbstractConstraintResult

Abstract supertype for all phylogeny-based constraint result types.

All concrete and/or abstract types representing the results of phylogeny-based constraint generation should be subtypes of AbstractPhylogenyConstraintResult.

Related

• SemiDefinitePhylogeny
• IntegerPhylogeny
• CentralityConstraint
• AbstractConstraintResult

const PlCE_PlC = Union{<:AbstractPhylogenyConstraintEstimator,
                       <:AbstractPhylogenyConstraintResult}

Alias for a phylogeny constraint estimator or result.

Matches either a AbstractPhylogenyConstraintEstimator or a AbstractPhylogenyConstraintResult. Used internally for dispatch in phylogeny-based constraint generation.

Related

• AbstractPhylogenyConstraintEstimator
• AbstractPhylogenyConstraintResult

const VecPlC = AbstractVector{<:AbstractPhylogenyConstraintResult}

Alias for a vector of phylogeny constraint results.

Represents a collection of AbstractPhylogenyConstraintResult objects.

Related

• AbstractPhylogenyConstraintResult
• PlC_VecPlC

const PlC_VecPlC = Union{<:AbstractPhylogenyConstraintResult, <:VecPlC}

Alias for a single or vector of phylogeny constraint results.

Matches either a single AbstractPhylogenyConstraintResult or a vector of them (VecPlC).

Related

• AbstractPhylogenyConstraintResult
• VecPlC

const VecPlCE_PlC = AbstractVector{<:PlCE_PlC}

Alias for a vector of phylogeny constraint estimators or results.

Represents a collection of PlCE_PlC objects, enabling batch processing of multiple phylogeny-based constraint estimators or results.

Related

• PlCE_PlC

const PlCE_PlC_VecPlCE_PlC = Union{<:PlCE_PlC, <:VecPlCE_PlC}

Alias for a single or vector of phylogeny constraint estimators or results.

Matches either a single PlCE_PlC or a vector of them (VecPlCE_PlC). Used internally for dispatch on phylogeny-based constraint generation that accepts one or many constraints.

Related

• PlCE_PlC
• VecPlCE_PlC

const MatNum_PhRMatNum = Union{<:PhylogenyResult{<:MatNum}, <:MatNum}

Alias for a phylogeny result wrapping a numeric matrix or a numeric matrix directly.

Used internally to accept either a PhylogenyResult containing a numeric matrix or a plain numeric matrix as a constraint matrix input.

Related

• PhylogenyResult
• MatNum

const Lc_CC_VecCC = Union{<:CC_VecCC, <:LinearConstraint}

Alias for a centrality constraint or linear constraint.

Matches either a CentralityConstraint, a vector of them, or a LinearConstraint. Used for dispatch in centrality-based constraint generation that also accepts linear constraints.

Related

• CC_VecCC
• LinearConstraint

_validate_length_integer_phylogeny_constraint_B(alg::Integer, B::VecNum)
_validate_length_integer_phylogeny_constraint_B(args...)

Check the length of B against an integer cluster count alg.

The fallback method takes every other argument list and checks nothing, so a clustering algorithm that is not an integer count places no bound on B. The default OptimalNumberClusters carries a SecondOrderDifference, so this guard is silent for it.

Arguments

• alg: Number of clusters the source returns.

  • Integer: Bounds length(B).
  • Anything else: No check is made.

• B: Vector of per-row bounds.

Validation

• length(B) <= alg, on the Integer method only. A breach raises a DomainError.

Returns

• nothing.

Related

• validate_length_integer_phylogeny_constraint_B: the caller, which applies the max_k bound before it delegates here.
• IntegerPhylogenyEstimator

validate_length_integer_phylogeny_constraint_B(cle::ClustersEstimator, B::VecNum)
validate_length_integer_phylogeny_constraint_B(args...)

Check the length of B against the number of clusters the estimator cle may return.

Only the ClustersEstimator method checks anything. Every other argument list reaches the fallback and passes, a NetworkEstimator included, so the commonest source of an IntegerPhylogenyEstimator is unguarded here. A network's row count is not known until phylogeny_matrix has run, and IntegerPhylogeny's own constructor raises then.

Arguments

• cle: Clustering estimator whose onc field states the number of clusters.
• B: Vector of per-row bounds.
• args...: Every other argument list. No check is made.

Validation

• length(B) <= cle.onc.max_k, when max_k is set. A breach raises a DomainError.
• length(B) <= cle.onc.alg, through _validate_length_integer_phylogeny_constraint_B, when alg is an Integer.
• Neither bound exists on the default OptimalNumberClusters(), whose max_k is nothing and whose alg is a SecondOrderDifference, so a B of any length passes.

Returns

• nothing.

Related

• _validate_length_integer_phylogeny_constraint_B: the delegate that applies the alg bound.
• IntegerPhylogenyEstimator