Enumeration¶
DimObjectSubtype¶
An enumeration with literals as the value of the Dimension objects’ type attribute.
Literal |
Description |
---|---|
linear |
Literal specifying an instance of a LinearDimension object. |
monotonic |
Literal specifying an instance of a MonotonicDimension object. |
labeled |
Literal specifying an instance of a LabeledDimension object. |
DVObjectSubtype¶
An enumeration with literals as the values of the DependentVariable object’ type attribute.
Literal |
Description |
---|---|
internal |
Literal specifying an instance of an InternalDependentVariable object. |
external |
Literal specifying an instance of an ExternalDependentVariable object. |
NumericType¶
An enumeration with literals as the value of the DependentVariable objects’ numeric_type attribute.
Literal |
Description |
---|---|
uint8 |
8-bit unsigned integer |
uint16 |
16-bit unsigned integer |
uint32 |
32-bit unsigned integer |
uint64 |
64-bit unsigned integer |
int8 |
8-bit signed integer |
int16 |
16-bit signed integer |
int32 |
32-bit signed integer |
int64 |
64-bit signed integer |
float32 |
32-bit floating point number |
float64 |
64-bit floating point number |
complex64 |
two 32-bit floating points numbers |
complex128 |
two 64-bit floating points numbers |
QuantityType¶
An enumeration with literals as the value of the DependentVariable objects’ quantity_type attribute. The value is used in interpreting the p-components of the dependent variable.
- scalar
A dependent variable with \(p=1\) component interpret as a scalar, \(\mathcal{S}_i=U_{0,i}\).
- vector_n
A dependent variable with \(p=n\) components interpret as vector components, \(\mathcal{V}_i= \left[ U_{0,i}, U_{1,i}, ... U_{n-1,i}\right]\).
- matrix_n_m
A dependent variable with \(p=mn\) components interpret as a \(n \times m\) matrix as follows,
(7)¶\[\begin{split}M_i = \left[ \begin{array}{cccc} U_{0,i} & U_{1,i} & ... &U_{(n-1)m,i} \\ U_{1,i} & U_{m+1,i} & ... &U_{(n-1)m+1,i} \\ \vdots & \vdots & \vdots & \vdots \\ U_{m-1,i} & U_{2m-1,i} & ... &U_{nm-1,i} \end{array} \right]\end{split}\]
- symmetric_matrix_n
A dependent variable with \(p=n^2\) components interpret as a matrix symmetric about its leading diagonal as shown below,
(8)¶\[\begin{split}M^{(s)}_i = \left[ \begin{array}{cccc} U_{0,i} & U_{1,i} & ... & U_{n-1,i} \\ U_{1,i} & U_{n,i} & ... &U_{2n-2,i} \\ \vdots & \vdots & \vdots & \vdots \\ U_{n-1,i} & U_{2n-2,i} & ... &U_{\frac{n(n+1)}{2}-1,i} \end{array} \right]\end{split}\]
- pixel_n
A dependent variable with \(p=n\) components interpret as image/pixel components, \(\mathcal{P}_i= \left[ U_{0,i}, U_{1,i}, ... U_{n-1,i}\right]\).
Here, the terms \(n\) and \(m\) are intergers.