MinMax

Library:
Simulink / Math Operations
HDL Coder / Math Operations

Ports

Input

`Port_1` — Input signal
scalar | vector | matrix

Provide an input signal from which the block outputs the maximum or minimum values.

When the block has one input port, the input must be a scalar or a vector. The block outputs a scalar equal to the minimum or maximum element of the input vector.
When the block has multiple input ports, all nonscalar inputs must have the same dimensions. The block expands any scalar inputs to have the same dimensions as the nonscalar inputs. The block outputs a signal having the same dimensions as the input. Each output element equals the minimum or maximum of the corresponding input elements.

Dependencies

To support matrix input, you must set the Number of input ports parameter to an integer greater than one. All nonscalar inputs must have the same dimensions.

`Port_N` — N-th input signal
scalar | vector | matrix

Provide an input signal from which the block outputs the maximum or minimum values.

When the block has multiple input ports, all nonscalar inputs must have the same dimensions. The block expands any scalar inputs to have the same dimensions as the nonscalar inputs. The block outputs a signal having the same dimensions as the input. Each output element equals the minimum or maximum of the corresponding input elements.

Dependencies

To provide more than one input signal, set the Number of input ports to an integer greater than 1.

Output

expand all

`Port_1` — Minimum or maximum values of inputs
scalar | vector | matrix

When the block has one input, the output is a scalar value, equal to the minimum or maximum of the input elements. When the block has multiple inputs, the output is a signal having the same dimensions as the input. Each output element equals the minimum or maximum of the corresponding input elements.

Parameters

expand all

Main

`Function` — Specify minimum or maximum
`min` (default) | `max`

Specify whether to apply the function min or max to the input.

Programmatic Use

Block Parameter: Function

Type: character vector

Values: 'min' | 'max'

Default: 'min'

`Number of input ports` — Specify number of input ports
`1` (default) | `positive integer`

Specify the number of inputs to the block.

Programmatic Use

Block Parameter: Inputs

Type: character vector

Values: positive integer

Default: '1'

`Enable zero-crossing detection` — Enable zero-crossing detection
`on` (default) | Boolean

Select to enable zero-crossing detection. For more information, see Zero-Crossing Detection.

Programmatic Use

Block Parameter: ZeroCross

Type: character vector, string

Values: 'off' | 'on'

Default: 'on'

`Sample time` — Specify sample time as a value other than `-1`
`-1` (default) | scalar | vector

Specify the sample time as a value other than -1. For more information, see Specify Sample Time.

Dependencies

This parameter is not visible unless it is explicitly set to a value other than -1. To learn more, see Blocks for Which Sample Time Is Not Recommended.

Programmatic Use

Block Parameter: SampleTime

Type: character vector

Values: scalar or vector

Default: '-1'

Signal Attributes

`Require all inputs to have the same data type` — Inputs must have the same data type
`off` (default) | `on`

Select this check box to require that all inputs have the same data type.

Programmatic Use

Block Parameter: InputSameDT

Type: character vector

Values: 'off' | 'on'

Default: 'off'

`Output minimum` — Minimum output value for range checking
`[]` (default) | scalar

Lower value of the output range that Simulink^® checks.

Simulink uses the minimum to perform:

Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters) for some blocks.
Simulation range checking (see Specify Signal Ranges and Enable Simulation Range Checking).
Automatic scaling of fixed-point data types.
Optimization of the code that you generate from the model. This optimization can remove algorithmic code and affect the results of some simulation modes such as SIL or external mode. For more information, see Optimize using the specified minimum and maximum values (Embedded Coder).

Note

Output minimum does not saturate or clip the actual output signal. Use the Saturation block instead.

Programmatic Use

Block Parameter: OutMin

Type: character vector

Values: '[ ]'| scalar

Default: '[ ]'

`Output maximum` — Maximum output value for range checking
`[]` (default) | scalar

Upper value of the output range that Simulink checks.

Simulink uses the maximum value to perform:

Parameter range checking (see Specify Minimum and Maximum Values for Block Parameters) for some blocks.
Simulation range checking (see Specify Signal Ranges and Enable Simulation Range Checking).
Automatic scaling of fixed-point data types.
Optimization of the code that you generate from the model. This optimization can remove algorithmic code and affect the results of some simulation modes such as SIL or external mode. For more information, see Optimize using the specified minimum and maximum values (Embedded Coder).

Note

Output maximum does not saturate or clip the actual output signal. Use the Saturation block instead.

Programmatic Use

Block Parameter: OutMax

Type: character vector

Values: '[ ]'| scalar

Default: '[ ]'

`Output data type` — Specify the output data type
`Inherit: Inherit via internal rule` (default) | `Inherit: Inherit via back propagation` | `double` | `single` | `half` | `int8` | `uint8` | `int16` | `uint16` | `int32` | `uint32` | `int64` | `uint64` | `fixdt(1,16,0)` | `fixdt(1,16,2^0,0)` | `<data type expression>`

Choose the data type for the output. The type can be inherited, specified directly, or expressed as a data type object such as Simulink.NumericType.

Click the Show data type assistant button to display the Data Type Assistant, which helps you set the data type attributes. For more information, see Specify Data Types Using Data Type Assistant.

Programmatic Use

Block Parameter: OutDataTypeStr

Type: character vector

Values:

'Inherit: Inherit via internal
										rule'

|

'Inherit: Inherit via back
										propagation'

'<data
										type expression>'

Default:

'Inherit:
										Inherit via internal rule'

`Lock output data type setting against changes by the fixed-point tools` — Prevent fixed-point tools from overriding Output data type
`off` (default) | `on`

Select this parameter to prevent the fixed-point tools from overriding the Output data type you specify on the block. For more information, see Use Lock Output Data Type Setting (Fixed-Point Designer).

Programmatic Use

Block Parameter: LockScale

Type: character vector

Values: 'off' | 'on'

Default: 'off'

`Integer rounding mode` — Rounding mode for fixed-point operations
`Floor` (default) | `Ceiling` | `Convergent` | `Nearest` | `Round` | `Simplest` | `Zero`

Specify the rounding mode for fixed-point operations. For more information, see Rounding (Fixed-Point Designer).

Block parameters always round to the nearest representable value. To control the rounding of a block parameter, enter an expression using a MATLAB^® rounding function into the mask field.

Programmatic Use

Block Parameter: RndMeth

Type: character vector

Values:

'Ceiling' | 'Convergent' | 'Floor' | 'Nearest' | 'Round' | 'Simplest' |
                        'Zero'

Default: 'Floor'

`Saturate on integer overflow` — Method of overflow action
`off` (default) | `on`

Specify whether overflows saturate or wrap.

Action Rationale Impact on Overflows Example

Action	Rationale	Impact on Overflows	Example
Select this check box (`on`).	Your model has possible overflow, and you want explicit saturation protection in the generated code.	Overflows saturate to either the minimum or maximum value that the data type can represent.	The maximum value that the `int8` (signed, 8-bit integer) data type can represent is 127. Any block operation result greater than this maximum value causes overflow of the 8-bit integer. With the check box selected, the block output saturates at 127. Similarly, the block output saturates at a minimum output value of -128.
Do not select this check box (`off`).	You want to optimize efficiency of your generated code. You want to avoid overspecifying how a block handles out-of-range signals. For more information, see Troubleshoot Signal Range Errors.	Overflows wrap to the appropriate value that is representable by the data type.	The maximum value that the `int8` (signed, 8-bit integer) data type can represent is 127. Any block operation result greater than this maximum value causes overflow of the 8-bit integer. With the check box cleared, the software interprets the overflow-causing value as `int8`, which can produce an unintended result. For example, a block result of 130 (binary 1000 0010) expressed as `int8`, is -126.

Select this check box (on).

Your model has possible overflow, and you want explicit saturation protection in the generated code.

Overflows saturate to either the minimum or maximum value that the data type can represent.

The maximum value that the int8 (signed, 8-bit integer) data type can represent is 127. Any block operation result greater than this maximum value causes overflow of the 8-bit integer. With the check box selected, the block output saturates at 127. Similarly, the block output saturates at a minimum output value of -128.

Do not select this check box (off).

You want to optimize efficiency of your generated code.

You want to avoid overspecifying how a block handles out-of-range signals. For more information, see Troubleshoot Signal Range Errors.

Overflows wrap to the appropriate value that is representable by the data type.

The maximum value that the int8 (signed, 8-bit integer) data type can represent is 127. Any block operation result greater than this maximum value causes overflow of the 8-bit integer. With the check box cleared, the software interprets the overflow-causing value as int8, which can produce an unintended result. For example, a block result of 130 (binary 1000 0010) expressed as int8, is -126.

When you select this check box, saturation applies to every internal operation on the block, not just the output, or result. Usually, the code generation process can detect when overflow is not possible. In this case, the code generator does not produce saturation code.

Programmatic Use

Block Parameter: SaturateOnIntegerOverflow

Type: character vector

Values: 'off' | 'on'

Default: 'off'

Model Examples

Find Maximum Value of Input

Use the MinMax block to output the maximum value of two sine waves.

Open Model

Modeling a Fault-Tolerant Fuel Control System

Combine Stateflow® with Simulink® to efficiently model hybrid systems. This type of modeling is particularly useful for systems that have numerous possible operational modes based on discrete events. Traditional signal flow is handled in Simulink while changes in control configuration are implemented in Stateflow. The model described below represents a fuel control system for a gasoline engine. The system is highly robust in that individual sensor failures are detected and the control system is dynamically reconfigured for uninterrupted operation.

Open Model

Block Characteristics

Data Types	`Boolean` \| `double` \| `fixed point` \| `half` \| `integer` \| `single`
Direct Feedthrough	`yes`
Multidimensional Signals	`yes`
Variable-Size Signals	`yes`
Zero-Crossing Detection	`yes`

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

HDL Code Generation
Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

HDL Coder™ provides additional configuration options that affect HDL implementation and synthesized logic.

HDL Architecture

This block has multi-cycle implementations that introduce additional latency in the generated code. To see the added latency, view the generated model or validation model. See Generated Model and Validation Model (HDL Coder).

Architecture	Additional cycles of latency	Description
`default` `Tree`	0	Generates a tree structure of comparators.
`Cascade`	1, when block has a single vector input port.	This implementation is optimized for latency * area, with medium speed. See Cascade Architecture Best Practices (HDL Coder).

HDL Block Properties

General
ConstrainedOutputPipeline	Number of registers to place at the outputs by moving existing delays within your design. Distributed pipelining does not redistribute these registers. The default is `0`. For more details, see ConstrainedOutputPipeline (HDL Coder).
InputPipeline	Number of input pipeline stages to insert in the generated code. Distributed pipelining and constrained output pipelining can move these registers. The default is `0`. For more details, see InputPipeline (HDL Coder).
OutputPipeline	Number of output pipeline stages to insert in the generated code. Distributed pipelining and constrained output pipelining can move these registers. The default is `0`. For more details, see OutputPipeline (HDL Coder).
InstantiateStages	Generate a VHDL^® `entity` or Verilog^® `module` for each cascade stage. The default is `off`. See also InstantiateStages (HDL Coder).
SerialPartition	Specify partitions for Cascade-serial implementations as a vector of the lengths of each partition. The default setting uses the minimum number of stages. See also SerialPartition (HDL Coder).

Note

To enable the LatencyStrategy setting for the MinMax block, you must specify Tree as the HDL Architecture.

Native Floating Point
LatencyStrategy	Specify whether to map the blocks in your design to `inherit`, `Max`, `Min`, or `Zero` for the floating-point operator. The default is `inherit`. See also LatencyStrategy (HDL Coder).

Documentation

MinMax

Description

Ports

Input

Port_1 — Input signal scalar | vector | matrix

Dependencies

Port_N — N-th input signal scalar | vector | matrix

Dependencies

Output

Port_1 — Minimum or maximum values of inputs scalar | vector | matrix

Parameters

Main

Function — Specify minimum or maximum min (default) | max

Programmatic Use

Number of input ports — Specify number of input ports 1 (default) | positive integer

Programmatic Use

Enable zero-crossing detection — Enable zero-crossing detection on (default) | Boolean

Programmatic Use

Sample time — Specify sample time as a value other than -1 -1 (default) | scalar | vector

Dependencies

Programmatic Use

Signal Attributes

Require all inputs to have the same data type — Inputs must have the same data type off (default) | on

Programmatic Use

Output minimum — Minimum output value for range checking [] (default) | scalar

Programmatic Use

Output maximum — Maximum output value for range checking [] (default) | scalar

Programmatic Use

Output data type — Specify the output data type Inherit: Inherit via internal rule (default) | Inherit: Inherit via back propagation | double | single | half | int8 | uint8 | int16 | uint16 | int32 | uint32 | int64 | uint64 | fixdt(1,16,0) | fixdt(1,16,2^0,0) | <data type expression>

Programmatic Use

Lock output data type setting against changes by the fixed-point tools — Prevent fixed-point tools from overriding Output data type off (default) | on

Programmatic Use

Integer rounding mode — Rounding mode for fixed-point operations Floor (default) | Ceiling | Convergent | Nearest | Round | Simplest | Zero

Programmatic Use

Saturate on integer overflow — Method of overflow action off (default) | on

Programmatic Use

Model Examples

Find Maximum Value of Input

Modeling a Fault-Tolerant Fuel Control System

Block Characteristics

Extended Capabilities

C/C++ Code Generation Generate C and C++ code using Simulink® Coder™.

HDL Code Generation Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

PLC Code Generation Generate Structured Text code using Simulink® PLC Coder™.

Fixed-Point Conversion Design and simulate fixed-point systems using Fixed-Point Designer™.

See Also

Simulink Documentation

Support

`Port_1` — Input signal
scalar | vector | matrix

`Port_N` — N-th input signal
scalar | vector | matrix

`Port_1` — Minimum or maximum values of inputs
scalar | vector | matrix

`Function` — Specify minimum or maximum
`min` (default) | `max`

`Number of input ports` — Specify number of input ports
`1` (default) | `positive integer`

`Enable zero-crossing detection` — Enable zero-crossing detection
`on` (default) | Boolean

`Sample time` — Specify sample time as a value other than `-1`
`-1` (default) | scalar | vector

`Require all inputs to have the same data type` — Inputs must have the same data type
`off` (default) | `on`

`Output minimum` — Minimum output value for range checking
`[]` (default) | scalar

`Output maximum` — Maximum output value for range checking
`[]` (default) | scalar

`Lock output data type setting against changes by the fixed-point tools` — Prevent fixed-point tools from overriding Output data type
`off` (default) | `on`

`Integer rounding mode` — Rounding mode for fixed-point operations
`Floor` (default) | `Ceiling` | `Convergent` | `Nearest` | `Round` | `Simplest` | `Zero`

`Saturate on integer overflow` — Method of overflow action
`off` (default) | `on`

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

HDL Code Generation
Generate Verilog and VHDL code for FPGA and ASIC designs using HDL Coder™.

PLC Code Generation
Generate Structured Text code using Simulink® PLC Coder™.

Fixed-Point Conversion
Design and simulate fixed-point systems using Fixed-Point Designer™.