dash.assert.defined

Throw error if numeric array contains undefined values

---

Syntax

dash.assert.defined(X)
dash.assert.defined(X, type)
dash.assert.defined(X, type, name, header)

---

Description

dash.assert.defined(X)

Throw error if X contains NaN, Inf, or complex-valued elements.

dash.assert.defined(X, type)

Optionally allow NaN or Inf values.

dash.assert.defined(X, type, name, header)

Customize thrown error IDs.

---

Input Arguments

X

X

numeric array

The array being checked

type

type

scalar integer

Indicates what special values are allowed

[1 (default)]: No special values are allowed

[2]: NaN values are allowed

[3]: Inf values are allowed

[4]: NaN and Inf values are allowed

name

name

string scalar

The name of the input in thrown error IDs

header

header

string scalar

Header for thrown error IDs.