Engee documentation

Sqrt

Calculates the square root, the signed square root, or the inverse of the square root.

blockType: Sqrt

Reciprocal Square Root

Path in the library:

/Basic/Math Operations/Reciprocal Square Root

SignedSqrt

Path in the library:

/Basic/Math Operations/SignedSqrt

Sqrt

Path in the library:

/Basic/Math Operations/Sqrt

Description

Block Sqrt calculates the square root, the signed square root, or the inverse of the square root of the input signal.

The function calculated by the block and the block icon depend on the parameter value. Function.

Parameter Value Function Description Mathematical expression The block icon

sqrt

The square root of the input signal

sqrt

signedSqrt

The square root of the absolute value of the input signal multiplied by the sign of the input signal

signed sqrt

rSqrt

The inverse of the square root of the input signal

reciprocal square root

Ports

Input

# IN_1 — input signal
scalar | vector | matrix

Details

Input signal for calculating the square root, the square root with sign or the inverse of the square root.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128.

Complex numbers support

Yes

Output

# OUT_1 — output signal
scalar | vector | matrix

Details

An output signal representing the value of a square root, a square root with sign, or the inverse of a square root calculated from an input signal.

If the input signal is of integer type, the output signal must be of floating point type.

Data types

Float64.

Complex numbers support

No

Parameters

Parameters

# Function — the function that the block performs
sqrt | signedSqrt | rSqrt

Details

The mathematical function that the block calculates. The block icon changes according to the selected function.

Values

sqrt | signedSqrt | rSqrt

Default value

Program usage name

Operator

Tunable

No

Evaluatable

No

# Output signal type — type of output signal
auto | real | complex

Details

Specify the type of output signal in the Math Function block. how auto, real or complex.

Function

Type of input signal

Type of output signal

auto

real

complex

sqrt

real

real for non-negative inputs

NaN for negative inputs

real for non-negative inputs

NaN for negative inputs

complex

complex

complex

error

complex

signedSqrt

real

real

real

complex

complex

error

error

error

rSqrt

real

real

real

error

complex

error

error

error

Values

auto | real | complex

Default value

auto

Program usage name

OutputSignalType

Tunable

No

Evaluatable

No

Main

# Intermediate resultsthe description is missing
Inherit: auto | Inherit from input | Inherit from output | Float64 | Float32 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Fixed-point

Details

The description is missing.

Values

Inherit: auto | Inherit from input | Inherit from output | Float64 | Float32 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Fixed-point

Default value

Inherit: auto

Program usage name

IntermediateResultsDataTypeStr

Tunable

No

Evaluatable

No

# Intermediate results fixed-point typethe description is missing
Data type

Details

The description is missing.

Default value

fixdt(1, 16, 0)

Program usage name

IntermediateResultsDataTypeStrFixed

Tunable

No

Evaluatable

Yes

# Outputthe description is missing
Inherit: auto | Same as first input | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Fixed-point

Details

The description is missing.

Values

Inherit: auto | Same as first input | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Fixed-point

Default value

Same as first input

Program usage name

OutDataTypeStr

Tunable

No

Evaluatable

No

# Output fixed-point typethe description is missing
Data type

Details

The description is missing.

Default value

fixdt(1, 16, 0)

Program usage name

OutDataTypeStrFixed

Tunable

No

Evaluatable

Yes

# Integer rounding modethe description is missing
Ceiling | Convergent | Floor | Nearest | Round | Zero

Details

The description is missing.

Values

Ceiling | Convergent | Floor | Nearest | Round | Zero

Default value

Floor

Program usage name

RndMeth

Tunable

No

Evaluatable

No

# Saturate on integer overflowthe description is missing
Logical

Details

The description is missing.

Default value

true (switched on)

Program usage name

SaturateOnIntegerOverflow

Tunable

No

Evaluatable

No

Additional options

C code generation: Yes