Categories &

Functions List

Class Definition: missing

datatypes: missing

Array of missing values.

A special class to represent missing data to other data types.

Source Code: missing

Methods

missing: M = missing ()

missing always returns a scalar missing value. Use repmat to expand a scalar missing value to a missing array of desired dimensions.

missing: sz = size (M)
missing: dim_sz = size (M, dim)
missing: dim_sz = size (M, d1, d2, …)
missing: [rows, columns, …, dim_n_sz] = size (…)

sz = size (M) returns a row vector with the size (number of elements) of each dimension for the missing array M.

dim_sz = size (M, dim) returns the size of the corresponding dimension specified in dim. If dim is a vector, then dim_sz is a vector of the same length and with each element corresponding to a specified dimension. Multiple dimensions may also be specified as separate arguments.

With a single output argument, size returns a row vector. When called with multiple output arguments, size returns the size of dimension N in the Nth argument.

missing: out = ndims (M)

out = ndims (M) returns the number of dimensions of the missing array M.

missing: out = numel (M)

out = numel (M) returns the number of elements in the missing array M.

missing: TF = iscolumn (M)

TF = iscolumn (M) returns a logical scalar TF, which is true if the missing array M is a column vector and false otherwise. A column vector is a 2-D array for which size (X) returns [N, 1] with non-negative N.

missing: TF = isempty (M)

TF = isempty (M) returns a logical scalar TF, which is true if the missing array M is empty and false otherwise.

missing: TF = ismatrix (M)

TF = ismatrix (M) returns a logical scalar TF, which is true if the missing array M is a matrix and false otherwise. A matrix is an array of any type where ndims (X) == 2 and for which size (X) returns [H, W] with non-negative H and W.

missing: TF = isrow (M)

TF = isrow (M) returns a logical scalar TF, which is true if the missing array M is a row vector and false otherwise. A row vector is a 2-D array for which size (X) returns [1, N] with non-negative N.

missing: TF = isscalar (M)

TF = isscalar (M) returns a logical scalar TF, which is true if the missing array M is also a scalar and false otherwise. A scalar is a single element object for which size (X) returns [1, 1].

missing: TF = isvector (M)

TF = isvector (M) returns a logical scalar TF, which is true if the missing array M is a vector and false otherwise. A vector is a 2-D array for which one of the dimensions is equal to 1 (either 1×N or N×1). By definition, a scalar is also a vector.

missing: TF = eq (A, B)

TF = eq (A, B) is the equivalent of the syntax TF = A == B and returns a logical array of the same size as the largest input with its elements set to false. A and B must be size compatible, which translates to they can be the same size, one can be scalar, or for every dimension, their dimension sizes must be equal or one of them must be 1.

One of the input arguments may also be any type of array. Any comparison with missing arrays always returns false.

missing: TF = ge (A, B)

TF = ge (A, B) is the equivalent of the syntax TF = A >= B and returns a logical array of the same size as the largest input with its elements set to false. A and B must be size compatible, which translates to they can be the same size, one can be scalar, or for every dimension, their dimension sizes must be equal or one of them must be 1.

One of the input arguments may also be any type of array. Any comparison with missing arrays always returns false.

missing: TF = gt (A, B)

TF = gt (A, B) is the equivalent of the syntax TF = A > B and returns a logical array of the same size as the largest input with its elements set to false. A and B must be size compatible, which translates to they can be the same size, one can be scalar, or for every dimension, their dimension sizes must be equal or one of them must be 1.

One of the input arguments may also be any type of array. Any comparison with missing arrays always returns false.

missing: TF = le (A, B)

TF = le (A, B) is the equivalent of the syntax TF = A <= B and returns a logical array of the same size as the largest input with its elements set to false. A and B must be size compatible, which translates to they can be the same size, one can be scalar, or for every dimension, their dimension sizes must be equal or one of them must be 1.

One of the input arguments may also be any type of array. Any comparison with missing arrays always returns false.

missing: TF = lt (A, B)

TF = lt (A, B) is the equivalent of the syntax TF = A < B and returns a logical array of the same size as the largest input with its elements set to false. A and B must be size compatible, which translates to they can be the same size, one can be scalar, or for every dimension, their dimension sizes must be equal or one of them must be 1.

One of the input arguments may also be any type of array. Any comparison with missing arrays always returns false.

missing: TF = ne (A, B)

TF = ne (A, B) is the equivalent of the syntax TF = A != B and returns a logical array of the same size as the largest input with its elements set to false. A and B must be size compatible, which translates to they can be the same size, one can be scalar, or for every dimension, their dimension sizes must be equal or one of them must be 1.

One of the input arguments may also be any type of array. Any comparison with missing arrays always returns false.