Mode

Syntax

Mode(Inputs: Array)

Parameters

Input. Variable.

Description

It returns mode of the specified variable.

Comments

If more than one variable is specified in Inputs, then mode for corresponding variable values will be calculated. For example, mode for points from 2018 by all variables.

The variables in Inputs must be specified via comma.

It is available to set up calculation period for function. To do it, use the SetPeriod function by specifying it at any place of input array.

To calculate function without taking into account empty values, use the IgnoreMissing parameter by specifying it at any place of input array. Available parameter values:

Example

Formula Result Application
= Mode({Brazil|BCA},{Peru|BCA},False)

Mode of corresponding points of the Brazil|BCA and Peru|BCA series taking into account empty values.

It can be used in formulas of calculated series of time series database and in formulas of attribute-based models of modeling container.
= Mode(X1)

Mode of the X1 factor.

It can be used in model variable-based formulas of modeling container.
= Mode(1, 2, 3, 4, 2)

2

it can be used in any expressions.

See also:

Functions Available in Expression Editor │ Arithmetic Functions │ IModelling.Mode