Various functions can be used on creating and editing an expression:
Name |
Brief description |
| The Collapse method aggregates variable values. | |
| The Interpolate method disaggregates variable values. | |
| The InterpolateP method interpolates variable values according to a pattern. |
Name |
Brief description |
| The Abs method returns absolute value (modulus) of selected variable points. | |
| The AbsI method returns absolute value (modulus) of selected variable points, if this variable contains only integer values. | |
| The Average method returns average of selected variable points. | |
| The AverageI method returns the average of selected variable points, if this variable contains only integer values. | |
| The Cos method returns cosine of selected variable points. | |
| The Division method returns a quotient of pointwise division of two variables. | |
| The Exp method returns the result of raising the "e" number to the power, specified by variable point. | |
| The ExpX method returns the result of raising variable points to the specified power. | |
| The Fact method returns a factorial of selected variable points. | |
| The Floor method returns the result of rounding down variable points to a multiple of prescribed accuracy. | |
| The FloorI method returns the result of rounding down variable points to a multiple of prescribed accuracy. The variable must only contain integer values. | |
| The Int method rounds values of selected the variable down to the nearest integer. | |
| The Ln method returns a natural logarithm of specified variable points. | |
| The Log method returns a logarithm of the specified variable points with specified basis. | |
| The Log10 method returns a base-10 logarithm of specified variable points. | |
| The Max method returns the maximum value of variable points. | |
| The MaxI method returns the maximum value of variable points, if this variable contains only integer values. | |
| The Mean method returns mean for the specified variable. | |
| The Median method returns the median for the specified variable. | |
| The Min method returns a minimum value of variable points. | |
| The MinI method returns a minimum value of variable points, if this variable contains only integer values. | |
| The Mod_ method returns the remainder of the integer division of variable points values by a specified number. | |
| The Mode method returns the mode of the specified variable. | |
| The Modulus method returns the remainder of an integer division of variable points values by a specified number. | |
| The Mult method returns the product of the corresponding points for two or more variables. | |
| The Power method returns the result of raising variable points to the specified power. | |
| The PowerI method returns the result of raising variable points to the specified power. All variable points and the power must be integers. | |
| The Rand method returns a random uniformly distributed number, greater or equal to 0 and less than 1. | |
| The RandBetween method returns a random real number between two specified numbers. | |
| The RandbetweenI method returns a random integer between two specified integers. | |
| The Remainder method returns the remainder of division of variable points values by a specified number. | |
| The Round method rounds variable points values. | |
| The RoundDown method rounds down variable points values. | |
| The RoundUp method rounds up variable points values. | |
| The Sin method returns the sine of specified variable points. | |
| The Sqrt method returns the square root of specified variable points. | |
| The StDv method returns the standard deviation for the specified variable. | |
| The Subtract method returns the difference of corresponding points for two or more variables. | |
| The Tan method returns the tangent of specified variable points. | |
| The Trunc method truncates variable points to a specified number of decimals. | |
| The Variance method returns variance of the variable. |
NOTE. In the Modeling and Forecasting unit it is prohibited to use the AbsI, FloorI, PowerI, RandBetweenI, MinI, MaxI functions in the models calculated in transformation problem.
Name |
Brief description |
| SubTotal | The SubTotal method returns value of subtotal, that is, value of the total of dimension items by the item of the upper dimension. |
| Total | The Total property returns the total value. |
On using the Total function consider the following:
If the calculated element is located in columns and the function is set with the Column Totals parameter, or the calculated element is located in rows and the function is set with the Row Totals parameter:
If the Total function is set for the current dimension item without specifying the particular item in the formula, and the appropriate total method is calculated for the table, the grand total will be calculated by this item.
If a new calculated element was added, and a formula is not calculated for it where the total could be taken, value of the Total function by this calculated element will be empty. In order value of the Total function by the new element should not be empty, add transformation for the new calculated element so that the total can be calculated by it, and then add transformation with the total function.
If another element is specified for the calculated element in the formula, the grand total will be calculated by the specified element.
If the calculated element is located in columns and the function is set with the Row Totals parameter, or the calculated element is located in rows and the function is set with the Column Totals parameter, value of the calculated element will correspond to value of the grand total by rows or columns, respectively.
On using the SubTotal function consider the following:
If the calculated element is located in columns and the function is set with the Column Totals parameter, or the calculated element is located in rows and the function is set with the Row Totals parameter:
If the SubTotal function is set for the current dimension item without specifying the particular item in the formula, and the appropriate total method is calculated for the table, the subtotal is calculated by this item.
If a new calculated element was added, and a formula is calculated for it where the total could be taken, value of the SubTotal function by this calculated element will be empty. In order value of the SubTotal function by the new item should not be empty, add transformation for the new calculated element so that the total can be calculated by it, and then add transformation with the total function.
If the data table heading or sidehead contain several dimensions, the subtotal is calculated by the last dimension in the heading or sidehead.
If another item is specified for the calculated element in the formula, the subtotal is calculated by the specified item.
If the calculated element is located in columns and the function is set with the Row Totals parameter, or the calculated element is located in rows and the function is set with the Column Totals parameter, value of the calculated element will correspond to value of the subtotal by rows or columns, respectively.
If the total or subtotal by rows or columns is not calculated, the corresponding functions set in the formulas return empty value. For example, if a formula is set as SubTotal, but the Sum total by columns for the table is not calculated, this function returns empty value.
Name |
Brief description |
| The Iif method provides conditional execution of operators. | |
| The Sign method returns sign of specified variable points. | |
| The SignI method returns sign of specified variable points, if this variable contains only integer values. |
NOTE. The SignI function cannot be used in the Modeling and Forecasting unit for the models calculated in transformation problem.
Name |
Brief description |
| The ArimaR method models variable's values by means of the ARIMA method with the help of R package. | |
| The BpfR method models variable's values by means of the Baxter-King filter with the help of R package. | |
| The ExpsmoothR method transforms variable data by means of exponential smoothing with the help of R package. | |
| The HpfR method smoothes variable data by means of the Hodrick-Prescott filter with the help of R package. | |
| The MedianSmoothR method executes median smoothing of variable with the help of R package. | |
| The MovAvgR method transforms variable data by means of moving average filter with the help of R package. | |
| The OlsR method models variable data by means of linear regression (OLS estimation). Calculation is executed with the help of R package. | |
| The R method transforms data by means of R package methods. | |
| The TslsR method models variable data by means of linear regression (instrumental variables estimation). Calculation is executed with the help of R package. |
The category is available if user functions are connected to the expression editor. For details see the Connecting User Functions to Expression Editor section.
Name |
Brief description |
| The Cumulative method transforms variable using selected accumulation method. | |
| The CumulativeYTD method transforms the variable using selected accumulation method to the beginning of a year. | |
| The Diff method calculates increment of variable points in comparison with the previous period. | |
| The DiffX method calculates the increment of variable points in comparison with the specified period. | |
| The DiffY method calculates increment of variable points in comparison with the corresponding period of the previous year. | |
| The DLog method calculates the increment of logarithm of variable points in comparison with the previous period. | |
| The DLogX method calculates the increment of logarithm of variable points in comparison with the specified period. | |
| The Fill method calculates empty values of the variable using various methods. | |
| The Lag method shifts the variable forward by the specified number of points in a time period. | |
| The Lead method shifts the variable backwards by the specified number of points in a time period. | |
| The Level method applies the Level function to the specified variable. | |
| The Pch method calculates the rate of change of variable points in comparison with the previous period. | |
| The PchA method calculates the rate of change of variable points in comparison with the previous period with seasonal adjustment. | |
| The PchX method calculates the rate of change of variable points in comparison with the specified period. | |
| The PchY method calculates the rate of change of variable points in comparison with corresponding period of the previous year. | |
| The Ratio method calculates the rate of change of variable points. | |
| The Rebase method applies the Rebase function to the specified variable. | |
| The Splice method splices variables. | |
| The SpliceP method transforms the variable on the basis of spliced variables. | |
| The Sum method returns the sum of corresponding points for two or more variables. | |
| The SumI method returns the sum of corresponding points for two or more variables, if these variables contain only integer values. | |
| The SumSq method returns the sum of squares of corresponding points for two or more variables. | |
| The Truncate method truncates the variable in accordance with selected parameters. |
NOTE. The SumI function cannot be used in the Modeling and Forecasting unit for the models calculated in transformation problem.
Name |
Brief description |
| The Arima method models variable values with the help of ARIMA method. | |
| The AutoTrend method selects optimal trend for variable in the specified period. | |
| The ExpSmooth method transforms variable with the help of exponential smoothing. | |
| The Extrapolate method transforms variable using a trend with functional dependency estimation. | |
| The GreyForecast method models a variable using the Grey Forecast method. |
Name |
Brief description |
| The Estimate method returns estimated value of a constant. | |
| The GetValueByDate method returns series value for the specific date. | |
| The IsSeriesEmpty method returns whether a series is empty. | |
| The None method returns whether a constant is not used. | |
| The Pi method returns the Pi constant. |
Name |
Brief description |
| Invoke | The Invoke method is used to execute specified function from specified unit using the Python language. |
For details about calling Python functions from Prognoz Platform 9 see the Calling Python Functions section.
Name |
Brief description |
| The Ecm method transforms variable using the error correction model. | |
| The Ols method models a variable with the help of linear regression (OLS estimation). | |
| The Tsls method models a variable with the help of linear regression (instrumental variables estimation). |
Name |
Brief description |
| The Bpf method models variable values with the help of the Baxter-King filter. | |
| The Hpf method smoothes a variable using the Hodrick-Prescott filter (smoothing parameter is lambda). | |
| The HpfP method smoothes a variable using the Hodrick-Prescott filter (smoothing parameter is power). | |
| The Lrxf method models variable with the help of LRX filter. | |
| The MedianSmooth method models a variable with the help of median smoothing. | |
| The MovAvg method transforms a variable with the help of moving average. | |
| The X11 method performs seasonal decomposition and data adjustment. |
Name |
Brief description |
| ASCII | The ASCII method returns ASCII code for the first row character. |
| Char | The Char method returns the character encoded with the ASCII code. |
| Contains | The Contains method returns True if this string contains the specified substring. |
| EndsWith | The EndsWith method returns True if this string ends with the specified substring. |
| Find | The Find method returns index of the substring position in the string, or 0 if the substring is not found. |
| Left | The Left method returns the specified number of characters from the beginning of string. |
| Length | The Length property determines string length. |
| Lower | The Lower method returns the string, which contains lower-case characters. |
| LTrim | The LTrim method returns the string with deleted spaces at the beginning. |
| Max_ | The Max_ method returns the maximum from a and b by means of character by character string comparison. |
| Mid | The Mid method returns the string starting with the position with the "start" index. |
| Min_ | The Min_ method returns the minimum from a and b by means of character by character string comparison. |
| Replace | The Replace method returns the string, in which all substring instances are replaced with the other string. |
| Right | The Right method returns the specified number of characters from the string end. |
| RTrim | The RTrim method returns the string with deleted spaces at the end. |
| Space | The Space method returns the string consisting of the specified number of repeated spaces. |
| StartsWith | The StartsWith method returns True if this string starts with the specified substring. |
| Trim | The Trim method returns the string with deleted spaces at the beginning and at the end. |
| Upper | The Upper method returns the string, which contains upper-case characters. |
See also:
Creating Formulas and Expressions
Aggregation