MaxI(Inputs: Array): Variant;
MaxI(Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext; Inputs: System.Array): object;
Context. Context. The parameter is used only in Fore.NET.
Inputs. Variable.
The MaxI method returns the maximum value of variable points if this variable contains only integer values.
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 calculated 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:
True. Default value. Calculation does not take into account empty values.
False. Calculation takes into account empty values.
To get the maximum value of the variable containing not only integer values, use the IModelling.Max method.
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, 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;
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 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 formula");
End If;
End Sub;
After executing the example the model calculates values of the second input variable increased by the maximum value of the first input variable.
Expression 1:
MaxI({Brazil|BCA}, SetPeriod(2000,2010))
Result: maximum values of observations of the Brazil|BCA series from 2000 to 2010. If some of the series contains real values, an error occurs.
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(False, X1, X2)
Result: maximum values of corresponding points of the X1 and X2 factors taking into account empty values.
Use: it can be used in model variable-based formulas of modeling container.
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