stateVector.overlap
Set whether ensemble members of variable can use overlapping, non-duplicate information
Syntax
Description
allowOverlap = obj.overlapallowOverlap = obj.overlap(-1)
Return the overlap permissions of all variables in the state vector.
allowOverlap = obj.overlap(v)allowOverlap = obj.overlap(variableNames)
Returns the overlap permissions for the indicated variables.
obj = obj.overlap(variables, allowOverlap)obj = obj.overlap(variables, true|”a”|”allow”)obj = obj.overlap(variables, false|”p”|”prohibit”)
Specify whether the ensemble members of indicated variables can use overlapping (but non-duplicate) information. Default is to prohibit overlap.
Input Arguments
v
logical vector | vector, linear indices [nVariables] | -1
The indices of the variables for which to set or return overlap permissions. If -1, selects all variables in the state vector.
variableNames
string vector [nVariables]
The names of the variables that should have overlap permissions adjusted.
allowOverlap
scalar logical | logical vector [nInput]
The overlap permissions to use for the listed variables.
[true|”a”|”allow”]: Allow ensemble members to use overlapping data
[false|”p”|”prohibit”]: Prohibit overlapping ensemble members
Output Arguments
allowOverlap
logical vector [nVariables | nInput]
Lists the current overlap permissions of the indicated variables. True if overlap is allowed, false if overlap is prohibited.
obj
scalar stateVector object
The stateVector object with updated overlap permissions.