IEmRamseyRessetTestSettings.Explained

Fore syntax

Explained: IEmSerie;

Fore.NET syntax

Explained: Prognoz.Platform.Interop.Modeller.IEmSerie;

Description

The Explained property determines an explained series.

Comments

If the explained series is not specified, correct calculation of the Functional Form Criterion method is not possible.

Fore example

To execute the example, add a link to the Modeller system assembly.

Sub RamseyResset;
Var
    ExprMod: IExpressModeller;
    Ar: Array[14] Of Double;
    Serie: IEmSerie;
    Sett: IEmRamseyRessetTestSettings;
    SList: IEmSeriesList;
    Period: IEmPeriodSettings;
Begin
    ExprMod := New ExpressModeller.Create;
    Sett := ExprMod.CreateRamseyRessetTestSettings;
    // Setting explained series
    Ar[0] := 56; Ar[1] := 45; Ar[2] := 23; Ar[3] := 45;
    Ar[4] := 65; Ar[5] := 23; Ar[6] := 54; Ar[7] := 87;
    Ar[8] := 67; Ar[9] := 98; Ar[10] := 89; Ar[13] := 79;
    Ar[11] := Double.Nan; Ar[12] := Double.Nan;
    Serie := ExprMod.Series.Add(Ar, "X1", "Data series 1");
    Sett.Explained := Serie;
    // Setting explanatory series
    Ar[0] := 58; Ar[1] := 50; Ar[2] := 26; Ar[4] := 72;
    Ar[5] := 28; Ar[6] := 62; Ar[7] := 95; Ar[8] := 74;
    Ar[10] := 94; Ar[11] := 100; Ar[12] := 54; Ar[13] := 81;
    Ar[3] := Double.Nan; Ar[9] := Double.Nan;
    Serie := ExprMod.Series.Add(Ar, "X2", "Data series 2");
    SList := Sett.Explanatories;
    SList.Add(Serie);
    // Setting degree value
    Sett.Power := 3;
    // Removing constant from the calculations
    Sett.HasConstant := False;
    // Setting calculation periods
    Period := Sett.Period;
    Period.BeginPeriod := 0;
    Period.EndPeriod := 13;
    // Performing calculation
    ExprMod.EvaluateMethod("C:\RamseyResset.html", Sett, True);
End Sub RamseyResset;

Example execution result: the Functional Form Criterion method is calculated with set parameters, calculation report is saved to the file C:\RamseyResset.html.

Fore.NET example

Imports Prognoz.Platform.Interop.Modeller;
…
Public Shared Sub RamseyResset();
Var
    ExprMod: IExpressModeller;
    Ar: Array[14] Of Double;
    Serie: IEmSerie;
    Sett: IEmRamseyRessetTestSettings;
    SList: IEmSeriesList;
    Period: IEmPeriodSettings;
Begin
    ExprMod := New ExpressModeller.Create();
    Sett := ExprMod.CreateRamseyRessetTestSettings();
    // Setting explained series
    Ar[0] := 56; Ar[1] := 45; Ar[2] := 23; Ar[3] := 45;
    Ar[4] := 65; Ar[5] := 23; Ar[6] := 54; Ar[7] := 87;
    Ar[8] := 67; Ar[9] := 98; Ar[10] := 89; Ar[13] := 79;
    Ar[11] := Double.Nan; Ar[12] := Double.Nan;
    Serie := ExprMod.Series.Add(Ar, "X1", "Data series 1");
    Sett.Explained := Serie;
    // Setting explanatory series
    Ar[0] := 58; Ar[1] := 50; Ar[2] := 26; Ar[4] := 72;
    Ar[5] := 28; Ar[6] := 62; Ar[7] := 95; Ar[8] := 74;
    Ar[10] := 94; Ar[11] := 100; Ar[12] := 54; Ar[13] := 81;
    Ar[3] := Double.Nan; Ar[9] := Double.Nan;
    Serie := ExprMod.Series.Add(Ar, "X2", "Data series 2");
    SList := Sett.Explanatories;
    SList.Add(Serie);
    // Setting degree value
    Sett.Power := 3;
    // Removing constant from the calculations
    Sett.HasConstant := False;
    // Setting calculation periods
    Period := Sett.Period;
    Period.BeginPeriod := 0;
    Period.EndPeriod := 13;
    // Performing calculation
    ExprMod.EvaluateMethod("C:\RamseyResset.html", Sett, True);
End Sub RamseyResset;

Example execution result: the Functional Form Criterion method is calculated with set parameters, calculation report is saved to the file C:\RamseyResset.html.