IModelling.Mod_

Syntax

Mod_(Input: Variant; Divisor: Variant): Variant;

Parameters

Input. Variable.

Divisor. Divisor.

Description

The Mod_ method returns remainder of integer division of variable point values by the specified number.

Comments

The result has the same sign as the dividend.

NOTE. The Mod_ and Modulus methods duplicate each other.

NOTE. If integer values are divided, the result will also be integer.

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.

Sub UserProc;

Var

Mb: IMetabase;

ModelSpace, ModelObj: IMetabaseObject;

Transf: IMsFormulaTransform;

Formula: IMsFormula;

Model: IMsModel;

Determ: IMsDeterministicTransform;

TransVar: IMsFormulaTransformVariable;

Slice: IMsFormulaTransformSlice;

TermInfo: IMsFormulaTermInfo;

Inp_1, Inp_2: String;

Expr: IExpression;

Begin

Mb := MetabaseClass.Active;

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;

TransVar := Transf.Inputs.Item(0);

Slice := TransVar.Slices.Item(0);

TermInfo := Transf.CreateTermInfo;

TermInfo.Slice := Slice;

TermInfo.Type := MsFormulaTermType.Pointwise;

Inp_1 := TermInfo.TermInnerText;

TransVar := Transf.Inputs.Item(1);

Slice := TransVar.Slices.Item(0);

TermInfo := Transf.CreateTermInfo;

TermInfo.Slice := Slice;

TermInfo.Type := MsFormulaTermType.Pointwise;

Inp_2 := TermInfo.TermInnerText;

Expr := Determ.Expression;

Expr.References := "Ms";

Expr.AsString := "Mod_(" + Inp_1 + ", " + Inp_2 + ")";

If Expr.Valid

Then ModelObj.Save;

Else Debug.WriteLine(The model is not saved: error in the formula);

End If;

End Sub UserProc;

After executing the example the model returns remainder of the integer division of the first input variable points by the appropriate points of the second input variable.

Example of Use in Expressions

Expression 1:

Mod_({Brazil|BCA},{China|BCA})

Result: the remainder from integer division of the Brazil|BCA factor is calculated to the corresponding China|BCA factor observations.

Use: it can be used in formulas of calculated series of time series database and model formulas of modeling container that is a child of the time series database.

Expression 2:

Mod_(X1,3)

Result: the remainder from integer division of X1 factor points to three is calculated.

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

Expression 3:

Mod_(15,4)

Result: 3.

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

See also:

IModelling