Builtin Functions¶

This pages describes all available builtin functions.

Cash flow functions¶

Add CashFlows¶

addCashFlows( e₁: Transfers , e₂: Transfers) : Transfers

The addCashFlows() function returns the pointwise addition of e₁and e₂. Note e₁and e₂should be Transfers of equal lenght.

Dicount¶

dicount( e₁: Transfers , e₂: Float , e₃: Float) : Float

The discount() function returns the discounted transfers, e₁, with interest rate e₂at timepoint e₃.

Dicount sub tax¶

discountSubTax( e₁: Transfers , e₂: Float , e₃: Float, e₄: Float) : Float

The discount() function returns the discounted transfers, e₁, with interest rate e₂at timepoint e₃subtracted the tax of e₄.

Scale¶

scale( e₁: Transfers , e₂: Float) : Transfers

The scale() function returns transfers e₁scaled by e₂₁.

Sum cashflows¶

sumCashFlows( e₁: List<Transfers>) : Transfers

The sumCashFlows() function returns the pointwise summed transfers of e₁.

IFunction functions¶

Create piecewise constant¶

createPiecewiseConstant(e₁: Transfers) : IFunction

The createPiecewiseConstant() function returns a piecewise IFunction specified by the transfers of e₁.

Create sum¶

createSum(e₁: List<IFunction> ) : IFunction

The createSum() function returns a IFunction resulting calling all IFunctions in the list e₁and summing the result of these.

List functions¶

Average¶

avg( e₁: List<Float> ) : Float

the avg() function returns the average of the list e₁.

Count¶

count( e₁: List<_> ) : Float

the count() function returns the length of the list e₁.

Max of list¶

maxOfList( e₁: List<Float> ) : Float

the maxOfList() function returns the maximum value in the list e₁.

Min of list¶

minOfList( e₁: List<Float> ) : Float

the minOfList() function returns the minimum value in the list e₁.

Range¶

range( e₁: Float , e₂: Float ) : List<Float>

the range() function returns a list containing all integer values in [e₁, e₂].

Single¶

single( e₁: List<T₁> ) : T₁

the single() function returns the single value contained in e₁. Note e₁must contain exactly one value.

Skip¶

skip( e₁: Float , e₂: List<T₁> ) : List<T₁>

the skip() function returns the list of e₂having skippid the first e₁elements.

Sum¶

sum( e₁: List<Float> ) : Float

the sum() function returns the summed values of e₁.

Unique¶

unique( e₁: List<T₁>) : List<₁>

The unique() function returns a list containing the unique elements of e₁.

Map functions¶

Create map¶

createMap( e₁: List<T₁> , e₂: List<T₂>) : Map<T₁,T₂>

The createMap() function returns a map from the values e₁to the values of e₂. Note e₁and e₂must be lists of equal length.

Map to values¶

mapToValues(e₁: Map<T₁, T₂>) : List<T₂>

the mapToValues() function returns a list containing all the values of e₁.

Math functions¶

Absolute¶

abs( e₁: Float ) : Float

The abs() function returns the absolute value of e₁. E.g. abs(-4) returns 4.

Bound¶

bound( e₁: Float , e₂: Float , e₃ : Float) : Float

the bound() function returns e₁bounded within e₂and e₃. E.g. bound(-3 , -2 , 3) returns -3.

Max¶

max( e₁: Float , e₂) : Float

the max() function returns the maximum of e₁and e₂. E.g. max(-3 , -2 ) returns -2.

Min¶

min( e₁: Float , e₂) : Float

the min() function returns the minimum of e₁and e₂. E.g. min(-3 , -2 ) returns -3.

Power¶

pow( e₁: Float , e₂: Float ) : Float

The pow() function returns e₁to the power of e₂. E.g. pow(4 , 3) returns 4 to the power of 3.

Sqr - Should be renamed to sqrt¶

sqr( e₁: Float ) : Float

the sqr() function returns the square root of e₁.