IModelling.MaxI

Syntax

MaxI(Inputs: Array): Variant;

Parameters

Inputs. Variable.

Description

The MaxI method returns the maximum value of variable points if this variable contains only integer values.

Comments

If more than one variable is specified in Inputs, the maximum values of corresponding variable points are calculated. For example, maximum values of points of 2018 by all variables.

Variables in Inputs must be separated via comma.

A calculation period can be set for the method. To do this, use the IModelling.SetPeriod method, by specifying it at any place of input array.

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

To get the maximum value of the variable containing not only integer values, use the IModelling.Max method.

Example

Executing the example requires that the repository contains a modeling container with the MS identifier. This contains includes a model with the MODEL_D identifier that is calculated by the determinate equation method and contains more than one input variable.

The first input variable must contain only integer values.

Add links to the Metabase and Ms system assemblies.

Sub UserMaxI;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    Term: IMsFormulaTerm;
    Inp_1: String;
    Expr: IExpression;
Begin
    Mb := MetabaseClass.Active;
    // Get model
    ModelSpace := Mb.ItemById("MS").Bind;
    ModelObj := Mb.ItemByIdNamespace("MODEL_D", ModelSpace.Key).Edit;
    Model := ModelObj As IMsModel;
    Transf := Model.Transform;
    Formula := Transf.FormulaItem(0);
    Determ := Formula.Method As IMsDeterministicTransform;
    // Get the first input variable
    Term := Determ.Operands.Item(0);
    Inp_1 := Term.TermToInnerText;
    // Get the second input variable
    Term := Determ.Operands.Item(1);
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := Term.TermToInnerText + "+MaxI(" + Inp_1 + ")";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("The model is not saved: error in formula");
    End If;
End Sub UserMaxI;

After executing the example the model calculates values of the second input variable increased by the maximum value of the first input variable.

Example of Use in Expressions

Expression 1:

MaxI({Brazil|BCA}, SetPeriod(2000,2010))

Result: maximum value of the Brazil|BCA series observations for the period 2000-2010. If any of the series contains real values, the error occurs.

Use: it can be used in formulas of cross functional expression editor in any platform tool where it is available.

Expression 2:

MaxI(False, X1, X2)

Result: maximum value of corresponding X1 and X2 factor points taking into account empty values.

Use: it can be used in model formulas of modeling container based on variables.

Expression 3:

MaxI(1, 2, 3, 4)

Result: 4.

Application: it can be used in any expressions.

See also:

IModelling | Time Series Database: Calculator | Modeling Container: Editing Regressor or Formula