- SystemML Class
`std/2009/source/numeric` - Summary
- Source of explicitly-specified numeric data
- Status
- Stable
## OverviewA source of explicitly-specified numeric data. The data to be output is specified as part of the parametrisation of the process, either explicitly (Explicit Mode) or as a filename of a binary data file containing the data (File Mode). Notes
- Please see Usage Notes at the bottom of this page.
## Connectivity- No inputs.
- One output, the data provided.
## StateThis Process stores its State in DataML. ## Explicit Mode- data (
`UINT32` ) - A numeric array holding the data to be output. The numeric type and complexity of the data output will be implied from the type of data supplied; its leading dimensions will give the dimensions of the output, and its last dimension the number of samples available. Hence, to supply 10 samples of
`[3x2]` data, this parameter should be of size`[3x2x10]` . - ndims (
`UINT32` scalar) OPTIONAL - Intended dimensionality of the output data (rarely required; see Usage Notes for Matlab).
## File ModeNote that in File Mode, - data (STRING)
- A filename of a binary file containing the data to be output. The file must be one of two expected sizes, given
`type` and`dims` (the complexity of the data is inferred from the size of the file). - type (STRING)
- Explicit primitive Numeric Type, in the form (for instance),
`DOUBLE` or`INT64` or`BOOL8` . - dims (
`INT64` 1xN) - Explicit dimensions. Note that this is the dimensions of the source data only; if you wish to use
`start` and`stop` , this value should not be changed. - sourceIsAdjacent (BOOL) OPTIONAL
- If true, and the source file is complex, it is assumed to be organised as two adjacent blocks (all real data, then all imaginary data). Otherwise, the source file is assumed to be organised in interleaved form (all real data for sample 1, all imaginary data for sample 1, all real data for sample 2, ...).
## All Modes- start (
`INT64` scalar) OPTIONAL - If present, the first source sample available is as specified (zero-based, so default is zero).
`start` and`stop` are particularly useful if you are using File Mode, and you want to source data from different places in a large file without rewriting the file every time. - stop (
`INT64` scalar) OPTIONAL - If present, the first source sample not available is as specified (zero-based, so default is the number of source samples present in
`data` ). - next (
`INT64` scalar) OPTIONAL - If present, the first source sample to be output (must fall between
`start` and`stop` ). - repeat (BOOLEAN scalar) OPTIONAL
- If true, the Process will begin using the provided data again when it runs out (i.e. when
`next` reaches the value of`stop` ). If false (default), the Process will raise an exception when it runs out of data. - complex (BOOLEAN scalar) OPTIONAL
- If present, the Process will produce output at the specified complexity rather than using the complexity inferred from
`data` , outputting zero as imaginary data or discarding imaginary data, as required. If empty (default), the output complexity is inferred from the source complexity. - outputName (STRING) OPTIONAL
- If supplied, the name of the single output (if not, "out" is used).
## ExampleBelow, we illustrate Explicit Mode. For an example of File Mode usage, see ## ScriptM Source Code (against 995)
fS
`sml_system` `addprocess` `addprocess` `addprocess` `brahms_execution` `brahms` ## Expected OutputMatlab Console
ans =
1 1 1
2 2 2
3 3 3
ans =
1 2 3
5 6 7
ans =
Columns 1 through 2
8 + 3i 8 + 3i
Column 3
8 + 3i
## Usage Notes## ComplexityThe source complexity and output complexity are independent. If you do not specify the output complexity (parameter ## Range ParametersSay If you explicitly set C/C++ Source Code
start
## Use from Matlab## Trailing Scalar DimensionsMatlab trims trailing scalar dimensions from any matrix, since this does not change it arithmetically (try This problem occurs most often when you wish to output a single column vector with the same value at every sample. You will pass in an ## ComplexityYou may wish to output complex data but, in some instances, the imaginary part of that data may be zero. Matlab will automatically truncate such matrices to be non-complex, following any operation. Therefore, note that you can force a complex representation of non-complex data in Matlab using the syntax |
||

This is a documentation page for the BRAHMS Modular Execution (Simulation) Framework. For details of licensing and distribution, please click here. To advise of an error or omission, please click here. |