IModelling.Average

Синтаксис

Average(Parameters: Array): Variant;

Параметры

Parameters. Переменная.

Описание

Метод Average возвращает среднее значение точек указанной переменной.

Комментарии

Если в Parameters указано больше одной переменной, то будет вычисляться среднее значение соответствующих точек переменных. Например, среднее значение точек за 2018 год по всем переменным.

Переменные в Parameters должны быть указаны через запятую.

Для метода доступно задание периода расчёта. Для этого используйте метод IModelling.SetPeriod, указав его в любом месте входного массива.

Для расчёта метода без учёта пустых значений используйте параметр IgnoreMissing, указав его в любом месте входного массива. Допустимые значения параметра:

Пример

Для выполнения примера в репозитории предполагается наличие контейнера моделирования с идентификатором MS. В данном контейнере содержится модель с идентификатором MODEL_D, рассчитываемая методом детерминированного уравнения и содержащая более одной входной переменной.

Добавьте ссылки на системные сборки: Metabase, Ms.

Sub UserProc;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    TermInfo: IMsFormulaTermInfo;
    Inp_1: 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.Serie;
    Inp_1 := TermInfo.TermInnerText;
    TransVar := Transf.Inputs.Item(1);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    TermInfo.Type := MsFormulaTermType.Pointwise;
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := TermInfo.TermInnerText + "+Average(" + Inp_1 + ", False)";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("Модель не сохранена: ошибка в формуле");
    End If;
End Sub UserProc;

В результате выполнения примера модель будет рассчитывать значения первой входной переменной c учётом пустых значений, увеличенные на значения второй входной переменной.

Пример использования в выражениях

Выражение 1:

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

Результат: рассчитано среднее значение наблюдений ряда «Brazil|BCA» за период с 2000 по 2010 год.

Применение: можно использовать в формулах универсального редактора выражения в любом инструменте платформы, где он доступен.

Выражение 2:

average(X1,X2,False)

Результат: рассчитано среднее значение точек факторов «X1» и «X2» с учётом пустых значений.

Применение: можно использовать в формулах моделей контейнера моделирования, основанных на переменных.

Выражение 3:

average(1, 2, 3, 4)

Результат: 2.5.

Применение: можно использовать в любых выражениях.

См. также:

IModelling | База данных временных рядов: Калькулятор | Контейнер моделирования: Редактирование регрессора/формулы