IModelling.MaxI

Fore Syntax

MaxI(Inputs: Array): Variant;

Fore.NET Syntax

MaxI(Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext; Inputs: System.Array): object;

Parameters

Context. Context. The parameter is used only in Fore.NET.

Inputs. Variable.

Description

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

Comments

The method provides a possibility to set calculation period. To do this, use the IModelling.SetPeriod method, by specifying it at any place of input array.

Use the IModelling.Max method to get maximum value of the variable containing not only integer values.

Fore Example

Executing the example requires that the repository contains a modeling container with the MS identifier. This container includes a model with the MODEL_D identifier that is calculated by method of determinate equation and containing more than one input variable. The first input variable must contain only integer values.

Add links to the Metabase, 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 maximum value of the first input variable.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.ForeSystem;
Imports Prognoz.Platform.Interop.Ms;

Public Shared Sub Main(Params: StartParams);
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    Term: IMsFormulaTerm;
    Inp_1: String;
    Expr: IExpression;
Begin
    Mb := Params.Metabase;
    // Get the 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 System.Diagnostics.Debug.WriteLine("Model is not saved: error in formulaquot;);
    End If;
End Sub;

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 from 2000 to 2010. If any series contains real values, the error appears.

Use: it can be used in formulas of calculated series of time series database and in formulas of attribute-based models of modeling container.

Expression 2:

MaxI(X1)

Result: maximum value of X1 factor points.

Use: it can be used in model variable-based formulas of modeling container.

Expression 3:

MaxI(1, 2, 3, 4)

Result: 4.

Use: it can be used in formulas of calculated series of time series database and modeling container models.

See also:

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