Skip to main content

%DeepSee.Query.scalarFunction

Class %DeepSee.Query.scalarFunction Extends %RegisteredObject [ System = 3 ]

This class defines the set of scalar functions allowed within DeepSee queries.

Methods

%IsScalarFunction

ClassMethod %IsScalarFunction(pFunc As %String) As %String

Test if pFunc is a scalar function. Return -1 if function is not a scalar function, otherwise return the number of arguments and (total number of) optional arguments (args:optargs) expected by the function.

%EvaluateScalar

ClassMethod %EvaluateScalar(pFunc As %String, pValue1 As %String = "", pValue2 As %String = "", pValue3 As %String = "", pValue4 As %String = "") As %String

Evaluate the given scalar function, pFunc, and return the result.

SQRT

ClassMethod SQRT(pValue As %Double) As %Double

Square root scalar function.

LOG

ClassMethod LOG(pValue As %Double) As %Double

Log base 10 scalar function.

POWER

ClassMethod POWER(pValue As %Double, pArg As %Double) As %Double

Power scalar function.

LOOKUP

ClassMethod LOOKUP(pTermList As %String, pKey As %String, pDefault As %String = "", pField As %String = "") As %String

Lookup a value in a term list.

ISNULL

ClassMethod ISNULL(pValue As %Double, pReplacement As %Double) As %Double

IsNull scalar function: If value is "", return replacment,

ROUND

ClassMethod ROUND(pValue As %Double, pDigits As %Integer = 0) As %Double

Round the given value to pDigits places.