GitHub

Vector scalar

PortfolioOptimisers.VecScalar — Type
struct VecScalar{__T_v, __T_s} <: AbstractResult

Represents a composite result containing a vector and a scalar.

Encapsulates a vector and a scalar value, commonly used for storing results that combine both types of data (e.g., weighted statistics, risk measures).

Fields

  • v: Vector component.
  • s: Scalar component.

Constructors

VecScalar(;    v::VecNum,    s::Number) -> VecScalar

Keywords correspond to the struct's fields.

Validation

  • v: !isempty(v) and all(isfinite, v).
  • s: isfinite(s).

Examples

julia> VecScalar([1.0, 2.0, 3.0], 4.2)VecScalar  v ┼ Vector{Float64}: [1.0, 2.0, 3.0]  s ┴ Float64: 4.2

Related

source