Engee documentation

Identity Matrix

Creating a unit matrix.

blockType: IdentityMatrix

Path in the library:

/Basic/Matrix Operations/Identity Matrix

Description

Block Identity Matrix outputs a unit matrix. The block generates a square or rectangular matrix, the elements of the main diagonal of which are equal to one, and the remaining elements are equal to zero.

Ports

Output

# OUT_1 — the identity matrix
scalar | vector | the matrix

Details

The identity matrix.

Data types

Float64, Float32, Float16, Int8, UInt8, Int16, UInt16, Int32, UInt32, Int64, UInt64, Int128, UInt128 Bool, Fixed-point

Complex numbers support

I don’t

Input

# IN_1 — Input signal
scalar | vector | the matrix

Details

An input signal that specifies the dimensions of the output matrix; a scalar, vector, or matrix. If the input signal is a matrix on , the block generates an output matrix on with the same sampling period as the input. The values of the elements of the input matrix are ignored.

Data types

Float64, Float32, Float16, Int8, UInt8, Int16, UInt16, Int32, UInt32, Int64, UInt64, Int128, UInt128 Bool, Fixed-point

Complex numbers support

I don’t

Parameters

Main

# Inherit output port attributes from input port — inheriting attributes of the output port from the input port
Logical

Details

If the parameter Inherit output port attributes from input port If enabled, the size, element type, and calculation step for the output matrix are determined by similar attributes of the input port. The other parameters are ignored.

If the parameter Inherit output port attributes from input port If it is disabled, the block behavior depends on the parameter values. Output dimensions, Output data type and Sample time.

Default value

false (switched off)

Program usage name

InheritOutputPortAttributes

Tunable

No

Evaluatable

No

# Output dimensions — size of the output matrix
Tuple of Int64

Details

The number of rows and columns in the output matrix. Possible values:

  • (N, M) — a single matrix of size is output on .

  • (N,) — the length vector is output .

  • () (empty tuple) — a scalar value is output 1 (size ()).

Default value

(5, 5)

Program usage name

OutputDimensions

Tunable

No

Evaluatable

Yes

# Output data type — type of output data
Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Bool | Fixed-point

Details

Specify the type of output data for this block.

Values

Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Bool | Fixed-point

Default value

Float64

Program usage name

OutDataTypeStr

Tunable

No

Evaluatable

No

# Output fixed-point type — the output type of fixed-point numbers
Data type

Details

Specify the output type of fixed-point numbers.

Dependencies

To use this parameter, set for the parameter Output data type meaning Fixed-point.

Default value

fixdt(1, 16, 0)

Program usage name

OutDataTypeStrFixed

Tunable

No

Evaluatable

Yes

# Sample time — the interval between the calculation steps
SampleTime (real number / vector of two real numbers)

Details

The interval between the calculation steps (a non-negative number). To inherit the calculation step, set this parameter to −1.

Default value

1

Program usage name

SampleTime

Tunable

No

Evaluatable

Yes

Additional options

C code generation: Yes