ensemble.nMembers

Return the number of members used by the ensemble objects in an array

Syntax



nMembers = obj.nMembers


nMembers = obj.nMembers(scope)


… = obj.nMembers(false|”u”|”used”)


… = obj.nMembers( true|”f”|”file”)

Description



nMembers = obj.nMembers

Returns the number of state vector rows being used for each element of an ensemble array. For evolving ensembles, the number of members is the number of ensemble members per ensemble in an evolving set.



nMembers = obj.nMembers(scope)


= obj.nMembers(false|”u”|”used”)


= obj.nMembers( true|”f”|”file”)

Indicate the scope in which to count members. If “used”|”u”|false, behaves identically to the previous syntax and counts the number of members used by each ensemble. If “file”|”f”|true, counts the number of ensemble members saved in the .ens file for each ensemble.

Input Arguments

scope

scalar logical | string scalar
Indicates the scope in which to count ensemble members.

[“used”|”u”|false (default)]: Counts members used by the ensemble

[“file”|”f”|true]: Counts members saved in the .ens file

Output Arguments

nMembers

numeric array
The number of members in each element of an ensemble array. Has the same size as obj.