FUNCTION

<MathVariable>

TYPE

FUNCTION

AbsOf()   

value: [DECIMAL | INTEGER]

Returns the absolute value of the given value. The return value is of the same data type as the parameter. 

ANBAgeOf ()

value1: DATE

value2: DATE

Computes the age in years given two dates (value2 minus value1). The calculation is based on moving value2 to the nearest anniversary of value1 and then calculating the age. For example, value1 = 3/15/1972 and value2 = 12/20/1981 then the result is 10, since value2 is closer to 3/15/1982 than it is to 3/15/1981.  

CalendarMonthsDiffOf()

value1: DATE

value2: DATE

Computes the number of calendar months between two dates (value2 minus value1). The result changes merely by the dates being in two different months. For example value1 = 1/28/2004 and value2 = 2/27/2004. Result is 1. Value1 = 1/28/2004 and value2 = 2/28/2004. Result is 1. Value1 = 1/28/2004 and value2 = 2/29/2004. Result is 1. Value1 = 1/28/2004 and value2 = 3/1/2004. Result is 2.           

CalendarQuarter()

value: DATE

Returns the next calendar quarter end date that follows the given date. For example, any input date prior to on equal to 3/31/2010 results in 3/31/2010. 

CalendarYearsDiffOf ()

value1: DATE

value2: DATE

Computes the number of years between two dates (value2 minus value1). When value2 reaches the calendar month in which an anniversary occurs, the result is incremented. For example, value1 = 2/29/2004 and value2 = 1/31/2005, result is 0. Value1 = 2/29/2004 and value2 = 2/1/2005, result is 1: the month in which the first anniversary occurs has been reached.     

value1 : [TEXT | BIGTEXT]

value2 : [TEXT | BIGTEXT]

DaysAdd()

value1: DATE

value2: INTEGER

Adds a number of days (value2) to a date. The resulting date is adjusted by the calendar. For example 1 day added to 2/28/2003 is 3/1/2003 whereas 1 day added to 2/28/2004 is 2/29/2004.  

DaysDiffOf()

value1 : DATE

value2 : DATE

Computes the number of days between two dates. (value2 minus value1). 

DaysOf()

value : DATE

Returns the day portion of the given date.

DurationOf()

value1: DATE

value2: DATE

Computes the number of full years between two dates (value2 minus value1) with the number of years unchanged until an anniversary of value1 is reached or exceeded by value2. For example value1 = 2/29/2004 and value2 = 2/27/2005, result is 0. value1 = 2/29/2004 and value2 = 2/28/2005, result is 1.  

FullMonthsDiffOf()

value1: DATE

value2: DATE

Computes the number of full calendar months between two dates (value2 minus value1). The result does not change merely by the dates being in two different months. It actually changes when a monthaversary of value1 is matched or exceeded by value2. For example value1 = 1/28/2004 and value2 = 2/27/2004. Result is 0. value1 = 1/28/2004 and value2 = 2/28/2004. Result is 1. value1 = 1/28/2004 and value2 = 2/29/2004. Result is 1. value1 = 1/28/2004 and value2 = 3/1/2004. Result is 1. value1 = 1/30/2004 and value2 = 2/29/2004. Result is 0. value1 = 1/30/2004 and value2 = 3/1/2004. Result = 1.              

GetBenefitSplit()

SegmentGUID: TEXT

EffectiveDate: DATE

BenefitSplitTypeCode: TEXT

ABLIndicator: TEXT

ExcludeFunds: Stringarray, TEXT

BenefitAmount: CURRENCY

ParentFundAmountCollection: COLLECTION

SegmentGUID - a math variable holding the related segment for the BenefitSplit record.

EffectiveDate - a math variable holding the valuation effective date for AsNetAssetValue records.

BenefitSplitTypeCode - a math variable or literal value indicating the BenefitSplit type code to retrieve.

ABLIndicator - a math variable holding either Yes or No, indicates if ABL is in effect and variable benefit is to be suppressed.

ExcludeFunds - a math variable holding an array of one or more benefit funds to exclude from the calculated output.

GivesBestDay()

value1: DATE

value2: INTEGER

Computes a date having the same month and year as the given date (value1) and with the specified day (value2) of the month. If the specified day causes the new date to roll over into the next month, the day is decreased to the last day of the month. For example, value1 = 2/15/2007 and value2 = 30, result is 2/28/2007. value1 = 7/4/2010 and value2 = 15, result is 7/15/2010.   

value1: [TEXT | BIGTEXT]

value2: [TEXT | BIGTEXT]

IsAlpha()

value: [TEXT | BIGTEXT]

Returns true if the parameter has alphabetic characters only.

IsAlphaNumeric()

value : [TEXT | BIGTEXT]

Returns true if the parameter has alphabetic or numeric characters.

IsEmpty()

value : [DATE | OBJECT | TEXT | BIGTEXT]

Returns true if given parameter has not been initialized or is null.

IsNumeric()

value: [TEXT | BIGTEXT]

Returns true if the parameter has numeric characters only.

value1: [TEXT | BIGTEXT]

value2: INTEGER

MaxDateOf()

value1 : DATE

value2 : DATE

Returns the greater of two dates.

MaxOf()

value1 : [DECIMAL | INTEGER]

value2 : [DECIMAL | INTEGER]

Returns the larger of two numbers. When any one of the parameter data types is DECIMAL, the return is DECIMAL. When both parameter data types are INTEGER, the return is INTEGER.  

MinDateOf()

value1 : DATE

value2 : DATE

Returns the lesser of two dates.

MinOf()

value1 : [DECIMAL | INTEGER],

value2 : [DECIMAL | INTEGER]

Returns the lesser of two numbers. Like MaxOf(), when any one of the parameter data types is a DECIMAL, the return is DECIMAL. When both parameter data types are INTEGERs, the return is INTEGER.   

MonthOf()

value : DATE

Returns the month portion of the given date.

MonthsAdd()

value1: DATE

value2: INTEGER

Adds a number of months (value2) to a date (value1). The resulting date is adjusted by the calendar. For example, 1 month added to 1/31/2004 is 2/29/2004.  

MonthsDiffOf()

value1: DATE

value2: DATE

Computes the number of months between two dates (value2 minus value1). It is the simple difference between the months of the two dates. For example, value1 = 2/28/2004 and value2 = 3/1/2004, result is 1. value1 = 2/28/2004 and value2 = 3/31/2004, result is 1. value1 = 2/28/2004 and value2 = 4/1/2004, result is 2.     

NextMultipleMode()

value1: DATE

value2: INTEGER

value3: INTEGER

Returns a date that is a number of modal units (value3) from the given date (value1). Value2 is a code value that identifies the mode. 

Code Value 1: Mode = Year 

Code Value 2: Mode = Half Year 

Code Value 4: Mode = Quarter 

Code Value 12: Mode = Month 

Code Value 24: Mode = Bi-week (every 15 days) 

Code Value 52: Mode = Week 

Note: Number is the number of modal units. 

value1: [TEXT, BIGTEXT]

value2: TEXT

value3: INTEGER

value1: [TEXT, BIGTEXT]

value2: TEXT

value3: INTEGER

PolMonthOf()

value1: DATE

value2: DATE

Computes the number of months at a specified point in time (value2) since the last anniversary based on value1. For example, value1 = 6/7/2008, value2 = 7/1/2008, return value is 2 and is 2 for every value of value2 that is within July. Return value changes to 3 for every value of value2 that is within August, etc. Value1 = 6/7/2008, value2 = 1//2010, return value is 8 (the 8th month from the last anniversary of value1).   

PresentValue()

value1: DECIMAL

value2: INTEGER

value3: DECIMAL

value4: DECIMAL

value5: DECIMAL

Calculates the present value of an investment. The present value is the total amount that a series of future payments is worth now.

- Value1 is the interest rate per period and must be expressed as a percentage. If the periods are monthly, divide the annual interest rate by 12. If the periods are quarterly, divide the annual interest rate by 4, etc.  

- Value2 is the total number of payment periods.  

- Value3 is the payment made each period and cannot change over the live of the annuity.

- Value4 is the future value or the cash balance you want to attain after the last payment is made.

- Value5 indicates the timing of payments within the periods. Value5 = 0 means the payment is due at the end of the period. Value5 = 1 means the payment is due at the beginning of the period.

QuartersAdd()

value1: DATE

value2: INTEGER

Adds a number (value2) of quarters (three months) to a date (value1).

value1: [TEXT, BIGTEXT]

value2: INTEGER

value1: [TEXT, BIGTEXT]

value2: INTEGER

ReplaceDayOfMonth()

value1: DATE

value2: INTEGER

Replaces the day portion of a date (value1) with a specified day of the month (value2).

ReplaceMonth()

value1: DATE

value2: INTEGER

Replaces the month portion of a date (value1) with the specified month (value2). January’s integer value is 0 and December’s integer value is 11. 

ReplaceYear()

value1: DATE

value2: INTEGER

Replaces the year portion of a date (value1) with the specified year (value2). A four- digit year must be used. 

value1: [TEXT, BIGTEXT]

value2: INTEGER

StringLength()

text : [TEXT, BIGTEXT]

Returns a positive integer indicating the number of Unicode characters contained in the input parameter. If the input string is null or 0, the function will return 0.

value1: [TEXT, BIGTEXT]

value2: INTEGER

value3: INTEGER

TableMult()

value: TEXT

Returns the rate multiplier for the given table rating code entered as the value. The table rating codes that may be passed and their resulting multipliers are: 

Table Rating Multiplier         

01 1                            

02 1.25                            

03 1.35                            

04 1.5                            

05 1.675                            

06 1.75                            

07 2                            

08 2.25                            

09 2.5                            

10 2.75                            

11 3                            

12 3.25                            

13 3.5                            

14 3.75                            

15 4                            

16 4.25                            

17 4.5                            

18 4.75                            

19 5                            

value 1: [DECIMAL | INTEGER]

value 2: STRING

ToDate()

value : [DATE | OBJECT | TEXT | BIGTEXT]

Returns the given value as a date.  

Casts input object to date array.

If input is null, returns NULL. If input is an instance of a date array, returns the object cast to an integer array. If the input is neither of the above, returns an error.

Casts input object to decimal array. Returned value is of type NUMERICARRAY and datatype DECIMALARRAY.

If input is null, returns NULL. If input is an instance of a decimal array, returns the object cast to an integer array. If the input is neither of the above, returns an error.

ToDecimal()

value : [DECIMAL | INTEGER | OBJECT | TEXT | BIGTEXT]

Converts the given value to a DECIMAL value.

ToInteger()

value : [DECIMAL | INTEGER | OBJECT | TEXT | BIGTEXT]

Converts the given value to an INTEGER value.  

If input is null, returns NULL. If input is an instance of an integer array, returns the object cast to an integer array. If the input is neither of the above, returns an error.

Casts input object to integer array. Returned value is of type NUMERICARRAY and datatype INTEGERARRAY.

If input is null, returns NULL. If input is an instance of an integer array, returns the object cast to an integer array. If the input is neither of the above, returns an error.

ToText()

value : [DECIMAL | INTEGER | OBJECT | TEXT | BIGTEXT]

Converts the given value to a TEXT value.  

Casts input object to string array. Returned value is of type/datatype STRINGARRAY

If input is null, returns NULL. If input is an instance of a text array, returns the object cast to an integer array. If the input is neither of the above, returns an error.

TruncateNumber()

value1: DECIMAL

value2: INTEGER

Truncates the number (value1) to a given number of decimal places (value2). When value2 is 0, a decimal is returned that holds an integer value. 

YearBeginOf()

value: DATE

Returns the first day of the year for the given date. For example, Date = 3/11/2010, return is 1//2010. 

Returns "12/31/n," where n is the year of the date entered as input.

If the date entered as input is null, throws an exception.

Returns the year of the date entered as input.

If the date entered as input is null, throws an exception.

value1: OBJECT

value2: INTEGER

Casts the object entered as value 1 as a date and adds or subtracts the number of years entered as value2 from value1.

If the object is null, returns NULL. If the object is a timestamp, date or string, casts the value as a date. If the object is not one of the datatypes above, throws an error.